[linux-block.git] / drivers / bluetooth / hci_uart.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *
 *  Bluetooth HCI UART driver
 *
 *  Copyright (C) 2000-2001  Qualcomm Incorporated
 *  Copyright (C) 2002-2003  Maxim Krasnyansky <maxk@qualcomm.com>
 *  Copyright (C) 2004-2005  Marcel Holtmann <marcel@holtmann.org>
 */

#ifndef N_HCI
#define N_HCI	15
#endif

/* Ioctls */
#define HCIUARTSETPROTO		_IOW('U', 200, int)
#define HCIUARTGETPROTO		_IOR('U', 201, int)
#define HCIUARTGETDEVICE	_IOR('U', 202, int)
#define HCIUARTSETFLAGS		_IOW('U', 203, int)
#define HCIUARTGETFLAGS		_IOR('U', 204, int)

/* UART protocols */
#define HCI_UART_MAX_PROTO	12

#define HCI_UART_H4	0
#define HCI_UART_BCSP	1
#define HCI_UART_3WIRE	2
#define HCI_UART_H4DS	3
#define HCI_UART_LL	4
#define HCI_UART_ATH3K	5
#define HCI_UART_INTEL	6
#define HCI_UART_BCM	7
#define HCI_UART_QCA	8
#define HCI_UART_AG6XX	9
#define HCI_UART_NOKIA	10
#define HCI_UART_MRVL	11

#define HCI_UART_RAW_DEVICE	0
#define HCI_UART_RESET_ON_INIT	1
#define HCI_UART_CREATE_AMP	2
#define HCI_UART_INIT_PENDING	3
#define HCI_UART_EXT_CONFIG	4
#define HCI_UART_VND_DETECT	5

struct hci_uart;
struct serdev_device;

struct hci_uart_proto {
	unsigned int id;
	const char *name;
	unsigned int manufacturer;
	unsigned int init_speed;
	unsigned int oper_speed;
	int (*open)(struct hci_uart *hu);
	int (*close)(struct hci_uart *hu);
	int (*flush)(struct hci_uart *hu);
	int (*setup)(struct hci_uart *hu);
	int (*set_baudrate)(struct hci_uart *hu, unsigned int speed);
	int (*recv)(struct hci_uart *hu, const void *data, int len);
	int (*enqueue)(struct hci_uart *hu, struct sk_buff *skb);
	struct sk_buff *(*dequeue)(struct hci_uart *hu);
};

struct hci_uart {
	struct tty_struct	*tty;
	struct serdev_device	*serdev;
	struct hci_dev		*hdev;
	unsigned long		flags;
	unsigned long		hdev_flags;

	struct work_struct	init_ready;
	struct work_struct	write_work;

	const struct hci_uart_proto *proto;
	struct percpu_rw_semaphore proto_lock;	/* Stop work for proto close */
	void			*priv;

	struct sk_buff		*tx_skb;
	unsigned long		tx_state;

	unsigned int init_speed;
	unsigned int oper_speed;

	u8			alignment;
	u8			padding;
};

/* HCI_UART proto flag bits */
#define HCI_UART_PROTO_SET	0
#define HCI_UART_REGISTERED	1
#define HCI_UART_PROTO_READY	2

/* TX states  */
#define HCI_UART_SENDING	1
#define HCI_UART_TX_WAKEUP	2

int hci_uart_register_proto(const struct hci_uart_proto *p);
int hci_uart_unregister_proto(const struct hci_uart_proto *p);
int hci_uart_register_device(struct hci_uart *hu, const struct hci_uart_proto *p);
void hci_uart_unregister_device(struct hci_uart *hu);

int hci_uart_tx_wakeup(struct hci_uart *hu);
int hci_uart_wait_until_sent(struct hci_uart *hu);
int hci_uart_init_ready(struct hci_uart *hu);
void hci_uart_init_work(struct work_struct *work);
void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
bool hci_uart_has_flow_control(struct hci_uart *hu);
void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
			 unsigned int oper_speed);

#ifdef CONFIG_BT_HCIUART_H4
int h4_init(void);
int h4_deinit(void);

struct h4_recv_pkt {
	u8  type;	/* Packet type */
	u8  hlen;	/* Header length */
	u8  loff;	/* Data length offset in header */
	u8  lsize;	/* Data length field size */
	u16 maxlen;	/* Max overall packet length */
	int (*recv)(struct hci_dev *hdev, struct sk_buff *skb);
};

#define H4_RECV_ACL \
	.type = HCI_ACLDATA_PKT, \
	.hlen = HCI_ACL_HDR_SIZE, \
	.loff = 2, \
	.lsize = 2, \
	.maxlen = HCI_MAX_FRAME_SIZE \

#define H4_RECV_SCO \
	.type = HCI_SCODATA_PKT, \
	.hlen = HCI_SCO_HDR_SIZE, \
	.loff = 2, \
	.lsize = 1, \
	.maxlen = HCI_MAX_SCO_SIZE

#define H4_RECV_EVENT \
	.type = HCI_EVENT_PKT, \
	.hlen = HCI_EVENT_HDR_SIZE, \
	.loff = 1, \
	.lsize = 1, \
	.maxlen = HCI_MAX_EVENT_SIZE

#define H4_RECV_ISO \
	.type = HCI_ISODATA_PKT, \
	.hlen = HCI_ISO_HDR_SIZE, \
	.loff = 2, \
	.lsize = 2, \
	.maxlen = HCI_MAX_FRAME_SIZE \

struct sk_buff *h4_recv_buf(struct hci_dev *hdev, struct sk_buff *skb,
			    const unsigned char *buffer, int count,
			    const struct h4_recv_pkt *pkts, int pkts_count);
#endif

#ifdef CONFIG_BT_HCIUART_BCSP
int bcsp_init(void);
int bcsp_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_LL
int ll_init(void);
int ll_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_ATH3K
int ath_init(void);
int ath_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_3WIRE
int h5_init(void);
int h5_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_INTEL
int intel_init(void);
int intel_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_BCM
int bcm_init(void);
int bcm_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_QCA
int qca_init(void);
int qca_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_AG6XX
int ag6xx_init(void);
int ag6xx_deinit(void);
#endif

#ifdef CONFIG_BT_HCIUART_MRVL
int mrvl_init(void);
int mrvl_deinit(void);
#endif
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4	2	/*
0372a662 MH	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>
1da177e4 LT	9	*/
1da177e4 LT	10
0372a662	11	#ifndef N_HCI
1da177e4 LT	12	#define N_HCI 15
	13	#endif
	14
	15	/* Ioctls */
d2158744 MH	16	#define HCIUARTSETPROTO _IOW('U', 200, int)
	17	#define HCIUARTGETPROTO _IOR('U', 201, int)
	18	#define HCIUARTGETDEVICE _IOR('U', 202, int)
63c7d09c JH	19	#define HCIUARTSETFLAGS _IOW('U', 203, int)
63c7d09c JH	20	#define HCIUARTGETFLAGS _IOR('U', 204, int)
1da177e4 LT	21
1da177e4 LT	22	/* UART protocols */
162f812f	23	#define HCI_UART_MAX_PROTO 12
1da177e4 LT	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
166d2f6a	29	#define HCI_UART_LL 4
b3190df6	30	#define HCI_UART_ATH3K 5
16e3887f	31	#define HCI_UART_INTEL 6
e9a2dd26	32	#define HCI_UART_BCM 7
0ff252c1	33	#define HCI_UART_QCA 8
395174bb	34	#define HCI_UART_AG6XX 9
9e69130c	35	#define HCI_UART_NOKIA 10
162f812f	36	#define HCI_UART_MRVL 11
1da177e4	37
63c7d09c	38	#define HCI_UART_RAW_DEVICE 0
a55e1f38	39	#define HCI_UART_RESET_ON_INIT 1
8a7a3fd6	40	#define HCI_UART_CREATE_AMP 2
9f2aee84	41	#define HCI_UART_INIT_PENDING 3
6afd04ad	42	#define HCI_UART_EXT_CONFIG 4
fb2ce8d1	43	#define HCI_UART_VND_DETECT 5
63c7d09c	44
1da177e4	45	struct hci_uart;
82f5169b	46	struct serdev_device;
1da177e4 LT	47
	48	struct hci_uart_proto {
	49	unsigned int id;
7c40fb8d	50	const char *name;
aee61f7a	51	unsigned int manufacturer;
7721383f FD	52	unsigned int init_speed;
7721383f FD	53	unsigned int oper_speed;
1da177e4 LT	54	int (open)(struct hci_uart hu);
	55	int (close)(struct hci_uart hu);
	56	int (flush)(struct hci_uart hu);
6ae4fddf	57	int (setup)(struct hci_uart hu);
7721383f	58	int (set_baudrate)(struct hci_uart hu, unsigned int speed);
9d1c40eb	59	int (recv)(struct hci_uart hu, const void *data, int len);
1da177e4 LT	60	int (enqueue)(struct hci_uart hu, struct sk_buff *skb);
	61	struct sk_buff (dequeue)(struct hci_uart *hu);
	62	};
	63
	64	struct hci_uart {
0372a662	65	struct tty_struct *tty;
82f5169b	66	struct serdev_device *serdev;
0372a662 MH	67	struct hci_dev *hdev;
0372a662 MH	68	unsigned long flags;
63c7d09c	69	unsigned long hdev_flags;
1da177e4	70
9f2aee84	71	struct work_struct init_ready;
da64c27d	72	struct work_struct write_work;
9f2aee84	73
4ee7ef19	74	const struct hci_uart_proto *proto;
67d2f878	75	struct percpu_rw_semaphore proto_lock; /* Stop work for proto close */
0372a662 MH	76	void *priv;
	77
	78	struct sk_buff *tx_skb;
	79	unsigned long tx_state;
2a973dfa IF	80
	81	unsigned int init_speed;
	82	unsigned int oper_speed;
aeac3014 SR	83
	84	u8 alignment;
	85	u8 padding;
1da177e4 LT	86	};
1da177e4 LT	87
63c7d09c	88	/* HCI_UART proto flag bits */
0372a662	89	#define HCI_UART_PROTO_SET 0
9f2aee84	90	#define HCI_UART_REGISTERED 1
84cb3df0	91	#define HCI_UART_PROTO_READY 2
1da177e4 LT	92
1da177e4 LT	93	/* TX states */
0372a662 MH	94	#define HCI_UART_SENDING 1
0372a662 MH	95	#define HCI_UART_TX_WAKEUP 2
1da177e4	96
4ee7ef19 MH	97	int hci_uart_register_proto(const struct hci_uart_proto *p);
4ee7ef19 MH	98	int hci_uart_unregister_proto(const struct hci_uart_proto *p);
82f5169b	99	int hci_uart_register_device(struct hci_uart hu, const struct hci_uart_proto p);
c34dc3bf	100	void hci_uart_unregister_device(struct hci_uart *hu);
82f5169b	101
1da177e4	102	int hci_uart_tx_wakeup(struct hci_uart *hu);
40fbb915	103	int hci_uart_wait_until_sent(struct hci_uart *hu);
9f2aee84	104	int hci_uart_init_ready(struct hci_uart *hu);
fdee6d8f	105	void hci_uart_init_work(struct work_struct *work);
7721383f	106	void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
b36a1552	107	bool hci_uart_has_flow_control(struct hci_uart *hu);
2a973dfa IF	108	void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
	109	void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
	110	unsigned int oper_speed);
1da177e4	111
0372a662 MH	112	#ifdef CONFIG_BT_HCIUART_H4
	113	int h4_init(void);
	114	int h4_deinit(void);
e1a38d70	115
79b8df93 MH	116	struct 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
ef564119 LAD	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
e1a38d70	153	struct sk_buff h4_recv_buf(struct hci_dev hdev, struct sk_buff *skb,
79b8df93 MH	154	const unsigned char *buffer, int count,
79b8df93 MH	155	const struct h4_recv_pkt *pkts, int pkts_count);
0372a662 MH	156	#endif
	157
	158	#ifdef CONFIG_BT_HCIUART_BCSP
	159	int bcsp_init(void);
	160	int bcsp_deinit(void);
	161	#endif
166d2f6a OBC	162
	163	#ifdef CONFIG_BT_HCIUART_LL
	164	int ll_init(void);
	165	int ll_deinit(void);
	166	#endif
b3190df6 SS	167
	168	#ifdef CONFIG_BT_HCIUART_ATH3K
	169	int ath_init(void);
	170	int ath_deinit(void);
	171	#endif
7dec65c8 JH	172
	173	#ifdef CONFIG_BT_HCIUART_3WIRE
	174	int h5_init(void);
	175	int h5_deinit(void);
	176	#endif
16e3887f	177
ca93cee5 LP	178	#ifdef CONFIG_BT_HCIUART_INTEL
	179	int intel_init(void);
	180	int intel_deinit(void);
	181	#endif
	182
bdd8818e MH	183	#ifdef CONFIG_BT_HCIUART_BCM
	184	int bcm_init(void);
	185	int bcm_deinit(void);
	186	#endif
0ff252c1 BYTK	187
	188	#ifdef CONFIG_BT_HCIUART_QCA
	189	int qca_init(void);
	190	int qca_deinit(void);
	191	#endif
395174bb LP	192
	193	#ifdef CONFIG_BT_HCIUART_AG6XX
	194	int ag6xx_init(void);
	195	int ag6xx_deinit(void);
	196	#endif
162f812f LP	197
	198	#ifdef CONFIG_BT_HCIUART_MRVL
	199	int mrvl_init(void);
	200	int mrvl_deinit(void);
	201	#endif