/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Bus abstraction interface for BES2600
 *
 * Copyright (c) 2022, Bestechnic (Beijing) Co., Ltd.
 * Replaces hwbus.h from drivers/net/wireless/st/cw1200/
 * Copyright (c) 2010, ST-Ericsson
 *
 *
 */

#ifndef BES2600_SBUS_H
#define BES2600_SBUS_H

/*
 * sbus priv forward definition.
 * Implemented and instantiated in particular modules.
 */
struct sbus_priv;
struct bes2600_common;

typedef void (*sbus_irq_handler)(void *priv);

enum SUBSYSTEM {
	SUBSYSTEM_MCU = 0,
	SUBSYSTEM_WIFI,
	SUBSYSTEM_BT,
	SUBSYSTEM_BT_LP,
};

enum GPIO_WAKE_FLAG
{
	GPIO_WAKE_FLAG_MCU = 0,
	GPIO_WAKE_FLAG_WIFI_ON,
	GPIO_WAKE_FLAG_WIFI_OFF,
	GPIO_WAKE_FLAG_BT_ON,
	GPIO_WAKE_FLAG_BT_OFF,
	GPIO_WAKE_FLAG_BT_LP_ON,
	GPIO_WAKE_FLAG_BT_LP_OFF,
	GPIO_WAKE_FLAG_HOST_SUSPEND,
	GPIO_WAKE_FLAG_HOST_RESUME,
	GPIO_WAKE_FLAG_SDIO_RX,
	GPIO_WAKE_FLAG_SDIO_PROBE,
};

struct sbus_ops {
	int (*init)(struct sbus_priv *self, struct bes2600_common *core);
	int (*sbus_memcpy_fromio)(struct sbus_priv *self, unsigned int addr,
					void *dst, int count);
	int (*sbus_memcpy_toio)(struct sbus_priv *self, unsigned int addr,
					const void *src, int count);
	void (*lock)(struct sbus_priv *self);
	void (*unlock)(struct sbus_priv *self);
	int (*irq_subscribe)(struct sbus_priv *self, sbus_irq_handler handler,
				void *priv);
	int (*irq_unsubscribe)(struct sbus_priv *self);
	int (*reset)(struct sbus_priv *self);
	size_t (*align_size)(struct sbus_priv *self, size_t size);
	int (*set_block_size)(struct sbus_priv *self, size_t size);
	int (*pipe_send)(struct sbus_priv *self, u8 pipe, u32 len, u8 *buf);
	void * (*pipe_read)(struct sbus_priv *self);
	int (*sbus_reg_read)(struct sbus_priv *self, u32 reg,
					void *buf, int count);
	int (*sbus_reg_write)(struct sbus_priv *self, u32 reg,
					const void *buf, int count);

	/* sub_system: 0 for mcu, 1 for wifi, 2 for bt, ... */
	int (*sbus_active)(struct sbus_priv *self, int sub_system);
	int (*sbus_deactive)(struct sbus_priv *self, int sub_system);
	int (*power_switch)(struct sbus_priv *self, int on);
	/* gpio wake, beacuse bes2600 sdio can't wakeup mcu, so add the two of interfaces */
	void (*gpio_wake)(struct sbus_priv *self, int falg);
	void (*gpio_sleep)(struct sbus_priv *self, int falg);
	/* halt device to get debug information */
	void (*halt_device)(struct sbus_priv *self);
	bool (*wakeup_source)(struct sbus_priv *self);
	int (*reboot)(struct sbus_priv *self);
	/*
	 * Force the host bus to re-detect and re-probe the chip. Called
	 * from the firmware-wedge recovery path when power_switch() has no
	 * effective chip-reset signal of its own (e.g. PineTab2, where the
	 * wifi-reset GPIO is owned by sdio_pwrseq, not the bes2600 node).
	 * Returns 0 on success or a negative errno.
	 */
	int (*bus_reset)(struct sbus_priv *self);
	/*
	 * Read a batch of RX frames inline from the bus and deliver each
	 * one via bes2600_bh_handle_rx_skb().  Called from the bh thread
	 * (process context, sleepable).  Replaces the
	 * sdio_rx_work + rx_queue + pipe_read relay (Patch C v3, 2026).
	 * Returns 0 on success, negative on read error.
	 */
	int (*bus_rx_batch)(struct sbus_priv *self);
};

void bes2600_irq_handler(struct bes2600_common *priv);

/* Patch H: __bes2600_irq_enable removed (was a stub). */

#endif /* BES2600_SBUS_H */