1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Marvell Bluetooth driver: global definitions & declarations
4 *
5 * Copyright (C) 2009, Marvell International Ltd.
6 */
7
8#include <linux/kthread.h>
9#include <linux/bitops.h>
10#include <linux/slab.h>
11#include <net/bluetooth/bluetooth.h>
12#include <linux/err.h>
13#include <linux/gfp.h>
14#include <linux/interrupt.h>
15#include <linux/io.h>
16#include <linux/of_platform.h>
17#include <linux/platform_device.h>
18#include <linux/pm_runtime.h>
19#include <linux/of_irq.h>
20
21#define BTM_HEADER_LEN			4
22#define BTM_UPLD_SIZE			2312
23
24/* Time to wait until Host Sleep state change in millisecond */
25#define WAIT_UNTIL_HS_STATE_CHANGED	msecs_to_jiffies(5000)
26/* Time to wait for command response in millisecond */
27#define WAIT_UNTIL_CMD_RESP		msecs_to_jiffies(5000)
28
29enum rdwr_status {
30	RDWR_STATUS_SUCCESS = 0,
31	RDWR_STATUS_FAILURE = 1,
32	RDWR_STATUS_DONE = 2
33};
34
35#define FW_DUMP_MAX_NAME_LEN    8
36#define FW_DUMP_HOST_READY      0xEE
37#define FW_DUMP_DONE            0xFF
38#define FW_DUMP_READ_DONE       0xFE
39
40struct memory_type_mapping {
41	u8 mem_name[FW_DUMP_MAX_NAME_LEN];
42	u8 *mem_ptr;
43	u32 mem_size;
44	u8 done_flag;
45};
46
47struct btmrvl_thread {
48	struct task_struct *task;
49	wait_queue_head_t wait_q;
50	void *priv;
51};
52
53struct btmrvl_device {
54	void *card;
55	struct hci_dev *hcidev;
56
57	u8 dev_type;
58
59	u8 tx_dnld_rdy;
60
61	u8 psmode;
62	u8 pscmd;
63	u8 hsmode;
64	u8 hscmd;
65
66	/* Low byte is gap, high byte is GPIO */
67	u16 gpio_gap;
68
69	u8 hscfgcmd;
70	u8 sendcmdflag;
71};
72
73struct btmrvl_adapter {
74	void *hw_regs_buf;
75	u8 *hw_regs;
76	u32 int_count;
77	struct sk_buff_head tx_queue;
78	u8 psmode;
79	u8 ps_state;
80	u8 hs_state;
81	u8 wakeup_tries;
82	wait_queue_head_t cmd_wait_q;
83	wait_queue_head_t event_hs_wait_q;
84	u8 cmd_complete;
85	bool is_suspended;
86	bool is_suspending;
87};
88
89struct btmrvl_private {
90	struct btmrvl_device btmrvl_dev;
91	struct btmrvl_adapter *adapter;
92	struct btmrvl_thread main_thread;
93	int (*hw_host_to_card)(struct btmrvl_private *priv,
94				u8 *payload, u16 nb);
95	int (*hw_wakeup_firmware)(struct btmrvl_private *priv);
96	int (*hw_process_int_status)(struct btmrvl_private *priv);
97	spinlock_t driver_lock;		/* spinlock used by driver */
98#ifdef CONFIG_DEBUG_FS
99	void *debugfs_data;
100#endif
101	bool surprise_removed;
102};
103
104#define MRVL_VENDOR_PKT			0xFE
105
106/* Vendor specific Bluetooth commands */
107#define BT_CMD_PSCAN_WIN_REPORT_ENABLE	0xFC03
108#define BT_CMD_ROUTE_SCO_TO_HOST	0xFC1D
109#define BT_CMD_SET_BDADDR		0xFC22
110#define BT_CMD_AUTO_SLEEP_MODE		0xFC23
111#define BT_CMD_HOST_SLEEP_CONFIG	0xFC59
112#define BT_CMD_HOST_SLEEP_ENABLE	0xFC5A
113#define BT_CMD_MODULE_CFG_REQ		0xFC5B
114#define BT_CMD_LOAD_CONFIG_DATA		0xFC61
115
116/* Sub-commands: Module Bringup/Shutdown Request/Response */
117#define MODULE_BRINGUP_REQ		0xF1
118#define MODULE_BROUGHT_UP		0x00
119#define MODULE_ALREADY_UP		0x0C
120
121#define MODULE_SHUTDOWN_REQ		0xF2
122
123/* Vendor specific Bluetooth events */
124#define BT_EVENT_AUTO_SLEEP_MODE	0x23
125#define BT_EVENT_HOST_SLEEP_CONFIG	0x59
126#define BT_EVENT_HOST_SLEEP_ENABLE	0x5A
127#define BT_EVENT_MODULE_CFG_REQ		0x5B
128#define BT_EVENT_POWER_STATE		0x20
129
130/* Bluetooth Power States */
131#define BT_PS_ENABLE			0x02
132#define BT_PS_DISABLE			0x03
133#define BT_PS_SLEEP			0x01
134
135/* Host Sleep states */
136#define HS_ACTIVATED			0x01
137#define HS_DEACTIVATED			0x00
138
139/* Power Save modes */
140#define PS_SLEEP			0x01
141#define PS_AWAKE			0x00
142
143#define BT_CAL_HDR_LEN			4
144#define BT_CAL_DATA_SIZE		28
145
146struct btmrvl_event {
147	u8 ec;		/* event counter */
148	u8 length;
149	u8 data[4];
150} __packed;
151
152/* Prototype of global function */
153
154int btmrvl_register_hdev(struct btmrvl_private *priv);
155struct btmrvl_private *btmrvl_add_card(void *card);
156int btmrvl_remove_card(struct btmrvl_private *priv);
157
158void btmrvl_interrupt(struct btmrvl_private *priv);
159
160bool btmrvl_check_evtpkt(struct btmrvl_private *priv, struct sk_buff *skb);
161int btmrvl_process_event(struct btmrvl_private *priv, struct sk_buff *skb);
162
163int btmrvl_send_module_cfg_cmd(struct btmrvl_private *priv, u8 subcmd);
164int btmrvl_pscan_window_reporting(struct btmrvl_private *priv, u8 subcmd);
165int btmrvl_send_hscfg_cmd(struct btmrvl_private *priv);
166int btmrvl_enable_ps(struct btmrvl_private *priv);
167int btmrvl_prepare_command(struct btmrvl_private *priv);
168int btmrvl_enable_hs(struct btmrvl_private *priv);
169
170#ifdef CONFIG_DEBUG_FS
171void btmrvl_debugfs_init(struct hci_dev *hdev);
172void btmrvl_debugfs_remove(struct hci_dev *hdev);
173#endif
174