1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 *
4 *  Bluetooth HCI UART driver
5 *
6 *  Copyright (C) 2000-2001  Qualcomm Incorporated
7 *  Copyright (C) 2002-2003  Maxim Krasnyansky <maxk@qualcomm.com>
8 *  Copyright (C) 2004-2005  Marcel Holtmann <marcel@holtmann.org>
9 */
10
11#ifndef N_HCI
12#define N_HCI	15
13#endif
14
15/* Ioctls */
16#define HCIUARTSETPROTO		_IOW('U', 200, int)
17#define HCIUARTGETPROTO		_IOR('U', 201, int)
18#define HCIUARTGETDEVICE	_IOR('U', 202, int)
19#define HCIUARTSETFLAGS		_IOW('U', 203, int)
20#define HCIUARTGETFLAGS		_IOR('U', 204, int)
21
22/* UART protocols */
23#define HCI_UART_MAX_PROTO	12
24
25#define HCI_UART_H4	0
26#define HCI_UART_BCSP	1
27#define HCI_UART_3WIRE	2
28#define HCI_UART_H4DS	3
29#define HCI_UART_LL	4
30#define HCI_UART_ATH3K	5
31#define HCI_UART_INTEL	6
32#define HCI_UART_BCM	7
33#define HCI_UART_QCA	8
34#define HCI_UART_AG6XX	9
35#define HCI_UART_NOKIA	10
36#define HCI_UART_MRVL	11
37
38#define HCI_UART_RAW_DEVICE	0
39#define HCI_UART_RESET_ON_INIT	1
40#define HCI_UART_CREATE_AMP	2
41#define HCI_UART_INIT_PENDING	3
42#define HCI_UART_EXT_CONFIG	4
43#define HCI_UART_VND_DETECT	5
44
45struct hci_uart;
46struct serdev_device;
47
48struct hci_uart_proto {
49	unsigned int id;
50	const char *name;
51	unsigned int manufacturer;
52	unsigned int init_speed;
53	unsigned int oper_speed;
54	int (*open)(struct hci_uart *hu);
55	int (*close)(struct hci_uart *hu);
56	int (*flush)(struct hci_uart *hu);
57	int (*setup)(struct hci_uart *hu);
58	int (*set_baudrate)(struct hci_uart *hu, unsigned int speed);
59	int (*recv)(struct hci_uart *hu, const void *data, int len);
60	int (*enqueue)(struct hci_uart *hu, struct sk_buff *skb);
61	struct sk_buff *(*dequeue)(struct hci_uart *hu);
62};
63
64struct hci_uart {
65	struct tty_struct	*tty;
66	struct serdev_device	*serdev;
67	struct hci_dev		*hdev;
68	unsigned long		flags;
69	unsigned long		hdev_flags;
70
71	struct work_struct	init_ready;
72	struct work_struct	write_work;
73
74	const struct hci_uart_proto *proto;
75	struct percpu_rw_semaphore proto_lock;	/* Stop work for proto close */
76	void			*priv;
77
78	struct sk_buff		*tx_skb;
79	unsigned long		tx_state;
80
81	unsigned int init_speed;
82	unsigned int oper_speed;
83
84	u8			alignment;
85	u8			padding;
86};
87
88/* HCI_UART proto flag bits */
89#define HCI_UART_PROTO_SET	0
90#define HCI_UART_REGISTERED	1
91#define HCI_UART_PROTO_READY	2
92
93/* TX states  */
94#define HCI_UART_SENDING	1
95#define HCI_UART_TX_WAKEUP	2
96
97int hci_uart_register_proto(const struct hci_uart_proto *p);
98int hci_uart_unregister_proto(const struct hci_uart_proto *p);
99int hci_uart_register_device(struct hci_uart *hu, const struct hci_uart_proto *p);
100void hci_uart_unregister_device(struct hci_uart *hu);
101
102int hci_uart_tx_wakeup(struct hci_uart *hu);
103int hci_uart_wait_until_sent(struct hci_uart *hu);
104int hci_uart_init_ready(struct hci_uart *hu);
105void hci_uart_init_work(struct work_struct *work);
106void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
107bool hci_uart_has_flow_control(struct hci_uart *hu);
108void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
109void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
110			 unsigned int oper_speed);
111
112#ifdef CONFIG_BT_HCIUART_H4
113int h4_init(void);
114int h4_deinit(void);
115
116struct h4_recv_pkt {
117	u8  type;	/* Packet type */
118	u8  hlen;	/* Header length */
119	u8  loff;	/* Data length offset in header */
120	u8  lsize;	/* Data length field size */
121	u16 maxlen;	/* Max overall packet length */
122	int (*recv)(struct hci_dev *hdev, struct sk_buff *skb);
123};
124
125#define H4_RECV_ACL \
126	.type = HCI_ACLDATA_PKT, \
127	.hlen = HCI_ACL_HDR_SIZE, \
128	.loff = 2, \
129	.lsize = 2, \
130	.maxlen = HCI_MAX_FRAME_SIZE \
131
132#define H4_RECV_SCO \
133	.type = HCI_SCODATA_PKT, \
134	.hlen = HCI_SCO_HDR_SIZE, \
135	.loff = 2, \
136	.lsize = 1, \
137	.maxlen = HCI_MAX_SCO_SIZE
138
139#define H4_RECV_EVENT \
140	.type = HCI_EVENT_PKT, \
141	.hlen = HCI_EVENT_HDR_SIZE, \
142	.loff = 1, \
143	.lsize = 1, \
144	.maxlen = HCI_MAX_EVENT_SIZE
145
146#define H4_RECV_ISO \
147	.type = HCI_ISODATA_PKT, \
148	.hlen = HCI_ISO_HDR_SIZE, \
149	.loff = 2, \
150	.lsize = 2, \
151	.maxlen = HCI_MAX_FRAME_SIZE \
152
153struct sk_buff *h4_recv_buf(struct hci_dev *hdev, struct sk_buff *skb,
154			    const unsigned char *buffer, int count,
155			    const struct h4_recv_pkt *pkts, int pkts_count);
156#endif
157
158#ifdef CONFIG_BT_HCIUART_BCSP
159int bcsp_init(void);
160int bcsp_deinit(void);
161#endif
162
163#ifdef CONFIG_BT_HCIUART_LL
164int ll_init(void);
165int ll_deinit(void);
166#endif
167
168#ifdef CONFIG_BT_HCIUART_ATH3K
169int ath_init(void);
170int ath_deinit(void);
171#endif
172
173#ifdef CONFIG_BT_HCIUART_3WIRE
174int h5_init(void);
175int h5_deinit(void);
176#endif
177
178#ifdef CONFIG_BT_HCIUART_INTEL
179int intel_init(void);
180int intel_deinit(void);
181#endif
182
183#ifdef CONFIG_BT_HCIUART_BCM
184int bcm_init(void);
185int bcm_deinit(void);
186#endif
187
188#ifdef CONFIG_BT_HCIUART_QCA
189int qca_init(void);
190int qca_deinit(void);
191#endif
192
193#ifdef CONFIG_BT_HCIUART_AG6XX
194int ag6xx_init(void);
195int ag6xx_deinit(void);
196#endif
197
198#ifdef CONFIG_BT_HCIUART_MRVL
199int mrvl_init(void);
200int mrvl_deinit(void);
201#endif
202