Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2)  * Marvell Bluetooth driver: global definitions & declarations
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4)  * Copyright (C) 2009, Marvell International Ltd.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  * This software file (the "File") is distributed by Marvell International
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7)  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8)  * (the "License").  You may use, redistribute and/or modify this File in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9)  * accordance with the terms and conditions of the License, a copy of which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10)  * is available by writing to the Free Software Foundation, Inc.,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11)  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12)  * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15)  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16)  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17)  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18)  * this warranty disclaimer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22) #include <linux/kthread.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) #include <linux/bitops.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) #include <net/bluetooth/bluetooth.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26) #include <linux/err.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) #include <linux/gfp.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28) #include <linux/interrupt.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) #include <linux/io.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) #include <linux/of_platform.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) #include <linux/platform_device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) #include <linux/pm_runtime.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) #include <linux/of_irq.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) #define BTM_HEADER_LEN			4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) #define BTM_UPLD_SIZE			2312
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) /* Time to wait until Host Sleep state change in millisecond */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) #define WAIT_UNTIL_HS_STATE_CHANGED	msecs_to_jiffies(5000)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) /* Time to wait for command response in millisecond */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) #define WAIT_UNTIL_CMD_RESP		msecs_to_jiffies(5000)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) enum rdwr_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44) 	RDWR_STATUS_SUCCESS = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) 	RDWR_STATUS_FAILURE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46) 	RDWR_STATUS_DONE = 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) #define FW_DUMP_MAX_NAME_LEN    8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50) #define FW_DUMP_HOST_READY      0xEE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) #define FW_DUMP_DONE            0xFF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52) #define FW_DUMP_READ_DONE       0xFE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54) struct memory_type_mapping {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) 	u8 mem_name[FW_DUMP_MAX_NAME_LEN];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56) 	u8 *mem_ptr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57) 	u32 mem_size;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) 	u8 done_flag;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) struct btmrvl_thread {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62) 	struct task_struct *task;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63) 	wait_queue_head_t wait_q;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64) 	void *priv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) struct btmrvl_device {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68) 	void *card;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) 	struct hci_dev *hcidev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 	u8 dev_type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 	u8 tx_dnld_rdy;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) 	u8 psmode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) 	u8 pscmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 	u8 hsmode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) 	u8 hscmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80) 	/* Low byte is gap, high byte is GPIO */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) 	u16 gpio_gap;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) 	u8 hscfgcmd;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) 	u8 sendcmdflag;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) struct btmrvl_adapter {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 	void *hw_regs_buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 	u8 *hw_regs;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) 	u32 int_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) 	struct sk_buff_head tx_queue;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) 	u8 psmode;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 	u8 ps_state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) 	u8 hs_state;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 	u8 wakeup_tries;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 	wait_queue_head_t cmd_wait_q;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 	wait_queue_head_t event_hs_wait_q;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 	u8 cmd_complete;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 	bool is_suspended;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) 	bool is_suspending;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) struct btmrvl_private {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) 	struct btmrvl_device btmrvl_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 	struct btmrvl_adapter *adapter;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) 	struct btmrvl_thread main_thread;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) 	int (*hw_host_to_card)(struct btmrvl_private *priv,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) 				u8 *payload, u16 nb);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 	int (*hw_wakeup_firmware)(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) 	int (*hw_process_int_status)(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 	spinlock_t driver_lock;		/* spinlock used by driver */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #ifdef CONFIG_DEBUG_FS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 	void *debugfs_data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 	bool surprise_removed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define MRVL_VENDOR_PKT			0xFE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) /* Vendor specific Bluetooth commands */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) #define BT_CMD_PSCAN_WIN_REPORT_ENABLE	0xFC03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) #define BT_CMD_ROUTE_SCO_TO_HOST	0xFC1D
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define BT_CMD_SET_BDADDR		0xFC22
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) #define BT_CMD_AUTO_SLEEP_MODE		0xFC23
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) #define BT_CMD_HOST_SLEEP_CONFIG	0xFC59
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) #define BT_CMD_HOST_SLEEP_ENABLE	0xFC5A
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define BT_CMD_MODULE_CFG_REQ		0xFC5B
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) #define BT_CMD_LOAD_CONFIG_DATA		0xFC61
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) /* Sub-commands: Module Bringup/Shutdown Request/Response */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define MODULE_BRINGUP_REQ		0xF1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) #define MODULE_BROUGHT_UP		0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define MODULE_ALREADY_UP		0x0C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) #define MODULE_SHUTDOWN_REQ		0xF2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) /* Vendor specific Bluetooth events */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) #define BT_EVENT_AUTO_SLEEP_MODE	0x23
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) #define BT_EVENT_HOST_SLEEP_CONFIG	0x59
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) #define BT_EVENT_HOST_SLEEP_ENABLE	0x5A
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) #define BT_EVENT_MODULE_CFG_REQ		0x5B
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) #define BT_EVENT_POWER_STATE		0x20
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) /* Bluetooth Power States */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) #define BT_PS_ENABLE			0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) #define BT_PS_DISABLE			0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) #define BT_PS_SLEEP			0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) /* Host Sleep states */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) #define HS_ACTIVATED			0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) #define HS_DEACTIVATED			0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) /* Power Save modes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) #define PS_SLEEP			0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) #define PS_AWAKE			0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) #define BT_CAL_HDR_LEN			4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define BT_CAL_DATA_SIZE		28
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) struct btmrvl_event {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 	u8 ec;		/* event counter */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) 	u8 length;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 	u8 data[4];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) } __packed;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) /* Prototype of global function */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) int btmrvl_register_hdev(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) struct btmrvl_private *btmrvl_add_card(void *card);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) int btmrvl_remove_card(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) void btmrvl_interrupt(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) int btmrvl_enable_ps(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) int btmrvl_prepare_command(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) int btmrvl_enable_hs(struct btmrvl_private *priv);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) #ifdef CONFIG_DEBUG_FS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) void btmrvl_debugfs_init(struct hci_dev *hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) void btmrvl_debugfs_remove(struct hci_dev *hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) #endif