hci_uart.h

  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	13
 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#define HCI_UART_AML	12
 38
 39#define HCI_UART_RAW_DEVICE	0
 40#define HCI_UART_RESET_ON_INIT	1
 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#define HCI_UART_NO_SUSPEND_NOTIFIER	3
 93#define HCI_UART_PROTO_INIT		4
 94
 95/* TX states  */
 96#define HCI_UART_SENDING	1
 97#define HCI_UART_TX_WAKEUP	2
 98
 99int hci_uart_register_proto(const struct hci_uart_proto *p);
100int hci_uart_unregister_proto(const struct hci_uart_proto *p);
101
102int hci_uart_register_device_priv(struct hci_uart *hu,
103				  const struct hci_uart_proto *p,
104				  int sizeof_priv);
105
106static inline int hci_uart_register_device(struct hci_uart *hu,
107					   const struct hci_uart_proto *p)
108{
109	return hci_uart_register_device_priv(hu, p, 0);
110}
111
112void hci_uart_unregister_device(struct hci_uart *hu);
113
114int hci_uart_tx_wakeup(struct hci_uart *hu);
115int hci_uart_wait_until_sent(struct hci_uart *hu);
116int hci_uart_init_ready(struct hci_uart *hu);
117void hci_uart_init_work(struct work_struct *work);
118void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
119bool hci_uart_has_flow_control(struct hci_uart *hu);
120void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
121void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
122			 unsigned int oper_speed);
123
124struct h4_recv_pkt {
125	u8  type;	/* Packet type */
126	u8  hlen;	/* Header length */
127	u8  loff;	/* Data length offset in header */
128	u8  lsize;	/* Data length field size */
129	u16 maxlen;	/* Max overall packet length */
130	int (*recv)(struct hci_dev *hdev, struct sk_buff *skb);
131};
132
133#define H4_RECV_ACL \
134	.type = HCI_ACLDATA_PKT, \
135	.hlen = HCI_ACL_HDR_SIZE, \
136	.loff = 2, \
137	.lsize = 2, \
138	.maxlen = HCI_MAX_FRAME_SIZE \
139
140#define H4_RECV_SCO \
141	.type = HCI_SCODATA_PKT, \
142	.hlen = HCI_SCO_HDR_SIZE, \
143	.loff = 2, \
144	.lsize = 1, \
145	.maxlen = HCI_MAX_SCO_SIZE
146
147#define H4_RECV_EVENT \
148	.type = HCI_EVENT_PKT, \
149	.hlen = HCI_EVENT_HDR_SIZE, \
150	.loff = 1, \
151	.lsize = 1, \
152	.maxlen = HCI_MAX_EVENT_SIZE
153
154#define H4_RECV_ISO \
155	.type = HCI_ISODATA_PKT, \
156	.hlen = HCI_ISO_HDR_SIZE, \
157	.loff = 2, \
158	.lsize = 2, \
159	.maxlen = HCI_MAX_FRAME_SIZE \
160
161#ifdef CONFIG_BT_HCIUART_H4
162int h4_init(void);
163int h4_deinit(void);
164
165struct sk_buff *h4_recv_buf(struct hci_uart *hu, struct sk_buff *skb,
166			    const unsigned char *buffer, int count,
167			    const struct h4_recv_pkt *pkts, int pkts_count);
168#endif
169
170#ifdef CONFIG_BT_HCIUART_BCSP
171int bcsp_init(void);
172int bcsp_deinit(void);
173#endif
174
175#ifdef CONFIG_BT_HCIUART_LL
176int ll_init(void);
177int ll_deinit(void);
178#endif
179
180#ifdef CONFIG_BT_HCIUART_ATH3K
181int ath_init(void);
182int ath_deinit(void);
183#endif
184
185#ifdef CONFIG_BT_HCIUART_3WIRE
186int h5_init(void);
187int h5_deinit(void);
188#endif
189
190#ifdef CONFIG_BT_HCIUART_INTEL
191int intel_init(void);
192int intel_deinit(void);
193#endif
194
195#ifdef CONFIG_BT_HCIUART_BCM
196int bcm_init(void);
197int bcm_deinit(void);
198#endif
199
200#ifdef CONFIG_BT_HCIUART_QCA
201int qca_init(void);
202int qca_deinit(void);
203#endif
204
205#ifdef CONFIG_BT_HCIUART_AG6XX
206int ag6xx_init(void);
207int ag6xx_deinit(void);
208#endif
209
210#ifdef CONFIG_BT_HCIUART_MRVL
211int mrvl_init(void);
212int mrvl_deinit(void);
213#endif
214
215#ifdef CONFIG_BT_HCIUART_AML
216int aml_init(void);
217int aml_deinit(void);
218#endif