[mirror_ubuntu-bionic-kernel.git] / drivers / bluetooth / hci_uart.h

/*
 *
 *  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>
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#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_init_ready(struct hci_uart *hu);
void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
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

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
1da177e4	1	/*
0372a662 MH	2	*
	3	* Bluetooth HCI UART driver
	4	*
	5	* Copyright (C) 2000-2001 Qualcomm Incorporated
	6	* Copyright (C) 2002-2003 Maxim Krasnyansky <maxk@qualcomm.com>
	7	* Copyright (C) 2004-2005 Marcel Holtmann <marcel@holtmann.org>
	8	*
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	23	*
1da177e4 LT	24	*/
1da177e4 LT	25
0372a662	26	#ifndef N_HCI
1da177e4 LT	27	#define N_HCI 15
	28	#endif
	29
	30	/* Ioctls */
d2158744 MH	31	#define HCIUARTSETPROTO _IOW('U', 200, int)
	32	#define HCIUARTGETPROTO _IOR('U', 201, int)
	33	#define HCIUARTGETDEVICE _IOR('U', 202, int)
63c7d09c JH	34	#define HCIUARTSETFLAGS _IOW('U', 203, int)
63c7d09c JH	35	#define HCIUARTGETFLAGS _IOR('U', 204, int)
1da177e4 LT	36
1da177e4 LT	37	/* UART protocols */
162f812f	38	#define HCI_UART_MAX_PROTO 12
1da177e4 LT	39
	40	#define HCI_UART_H4 0
	41	#define HCI_UART_BCSP 1
	42	#define HCI_UART_3WIRE 2
	43	#define HCI_UART_H4DS 3
166d2f6a	44	#define HCI_UART_LL 4
b3190df6	45	#define HCI_UART_ATH3K 5
16e3887f	46	#define HCI_UART_INTEL 6
e9a2dd26	47	#define HCI_UART_BCM 7
0ff252c1	48	#define HCI_UART_QCA 8
395174bb	49	#define HCI_UART_AG6XX 9
9e69130c	50	#define HCI_UART_NOKIA 10
162f812f	51	#define HCI_UART_MRVL 11
1da177e4	52
63c7d09c	53	#define HCI_UART_RAW_DEVICE 0
a55e1f38	54	#define HCI_UART_RESET_ON_INIT 1
8a7a3fd6	55	#define HCI_UART_CREATE_AMP 2
9f2aee84	56	#define HCI_UART_INIT_PENDING 3
6afd04ad	57	#define HCI_UART_EXT_CONFIG 4
fb2ce8d1	58	#define HCI_UART_VND_DETECT 5
63c7d09c	59
1da177e4	60	struct hci_uart;
82f5169b	61	struct serdev_device;
1da177e4 LT	62
	63	struct hci_uart_proto {
	64	unsigned int id;
7c40fb8d	65	const char *name;
aee61f7a	66	unsigned int manufacturer;
7721383f FD	67	unsigned int init_speed;
7721383f FD	68	unsigned int oper_speed;
1da177e4 LT	69	int (open)(struct hci_uart hu);
	70	int (close)(struct hci_uart hu);
	71	int (flush)(struct hci_uart hu);
6ae4fddf	72	int (setup)(struct hci_uart hu);
7721383f	73	int (set_baudrate)(struct hci_uart hu, unsigned int speed);
9d1c40eb	74	int (recv)(struct hci_uart hu, const void *data, int len);
1da177e4 LT	75	int (enqueue)(struct hci_uart hu, struct sk_buff *skb);
	76	struct sk_buff (dequeue)(struct hci_uart *hu);
	77	};
	78
	79	struct hci_uart {
0372a662	80	struct tty_struct *tty;
82f5169b	81	struct serdev_device *serdev;
0372a662 MH	82	struct hci_dev *hdev;
0372a662 MH	83	unsigned long flags;
63c7d09c	84	unsigned long hdev_flags;
1da177e4	85
9f2aee84	86	struct work_struct init_ready;
da64c27d	87	struct work_struct write_work;
9f2aee84	88
4ee7ef19	89	const struct hci_uart_proto *proto;
67d2f878	90	struct percpu_rw_semaphore proto_lock; /* Stop work for proto close */
0372a662 MH	91	void *priv;
	92
	93	struct sk_buff *tx_skb;
	94	unsigned long tx_state;
2a973dfa IF	95
	96	unsigned int init_speed;
	97	unsigned int oper_speed;
aeac3014 SR	98
	99	u8 alignment;
	100	u8 padding;
1da177e4 LT	101	};
1da177e4 LT	102
63c7d09c	103	/* HCI_UART proto flag bits */
0372a662	104	#define HCI_UART_PROTO_SET 0
9f2aee84	105	#define HCI_UART_REGISTERED 1
84cb3df0	106	#define HCI_UART_PROTO_READY 2
1da177e4 LT	107
1da177e4 LT	108	/* TX states */
0372a662 MH	109	#define HCI_UART_SENDING 1
0372a662 MH	110	#define HCI_UART_TX_WAKEUP 2
1da177e4	111
4ee7ef19 MH	112	int hci_uart_register_proto(const struct hci_uart_proto *p);
4ee7ef19 MH	113	int hci_uart_unregister_proto(const struct hci_uart_proto *p);
82f5169b	114	int hci_uart_register_device(struct hci_uart hu, const struct hci_uart_proto p);
c34dc3bf	115	void hci_uart_unregister_device(struct hci_uart *hu);
82f5169b	116
1da177e4	117	int hci_uart_tx_wakeup(struct hci_uart *hu);
9f2aee84	118	int hci_uart_init_ready(struct hci_uart *hu);
7721383f	119	void hci_uart_set_baudrate(struct hci_uart *hu, unsigned int speed);
2a973dfa IF	120	void hci_uart_set_flow_control(struct hci_uart *hu, bool enable);
	121	void hci_uart_set_speeds(struct hci_uart *hu, unsigned int init_speed,
	122	unsigned int oper_speed);
1da177e4	123
0372a662 MH	124	#ifdef CONFIG_BT_HCIUART_H4
	125	int h4_init(void);
	126	int h4_deinit(void);
e1a38d70	127
79b8df93 MH	128	struct h4_recv_pkt {
	129	u8 type; /* Packet type */
	130	u8 hlen; /* Header length */
	131	u8 loff; /* Data length offset in header */
	132	u8 lsize; /* Data length field size */
	133	u16 maxlen; /* Max overall packet length */
	134	int (recv)(struct hci_dev hdev, struct sk_buff *skb);
	135	};
	136
	137	#define H4_RECV_ACL \
	138	.type = HCI_ACLDATA_PKT, \
	139	.hlen = HCI_ACL_HDR_SIZE, \
	140	.loff = 2, \
	141	.lsize = 2, \
	142	.maxlen = HCI_MAX_FRAME_SIZE \
	143
	144	#define H4_RECV_SCO \
	145	.type = HCI_SCODATA_PKT, \
	146	.hlen = HCI_SCO_HDR_SIZE, \
	147	.loff = 2, \
	148	.lsize = 1, \
	149	.maxlen = HCI_MAX_SCO_SIZE
	150
	151	#define H4_RECV_EVENT \
	152	.type = HCI_EVENT_PKT, \
	153	.hlen = HCI_EVENT_HDR_SIZE, \
	154	.loff = 1, \
	155	.lsize = 1, \
	156	.maxlen = HCI_MAX_EVENT_SIZE
	157
e1a38d70	158	struct sk_buff h4_recv_buf(struct hci_dev hdev, struct sk_buff *skb,
79b8df93 MH	159	const unsigned char *buffer, int count,
79b8df93 MH	160	const struct h4_recv_pkt *pkts, int pkts_count);
0372a662 MH	161	#endif
	162
	163	#ifdef CONFIG_BT_HCIUART_BCSP
	164	int bcsp_init(void);
	165	int bcsp_deinit(void);
	166	#endif
166d2f6a OBC	167
	168	#ifdef CONFIG_BT_HCIUART_LL
	169	int ll_init(void);
	170	int ll_deinit(void);
	171	#endif
b3190df6 SS	172
	173	#ifdef CONFIG_BT_HCIUART_ATH3K
	174	int ath_init(void);
	175	int ath_deinit(void);
	176	#endif
7dec65c8 JH	177
	178	#ifdef CONFIG_BT_HCIUART_3WIRE
	179	int h5_init(void);
	180	int h5_deinit(void);
	181	#endif
16e3887f	182
ca93cee5 LP	183	#ifdef CONFIG_BT_HCIUART_INTEL
	184	int intel_init(void);
	185	int intel_deinit(void);
	186	#endif
	187
bdd8818e MH	188	#ifdef CONFIG_BT_HCIUART_BCM
	189	int bcm_init(void);
	190	int bcm_deinit(void);
	191	#endif
0ff252c1 BYTK	192
	193	#ifdef CONFIG_BT_HCIUART_QCA
	194	int qca_init(void);
	195	int qca_deinit(void);
	196	#endif
395174bb LP	197
	198	#ifdef CONFIG_BT_HCIUART_AG6XX
	199	int ag6xx_init(void);
	200	int ag6xx_deinit(void);
	201	#endif
162f812f LP	202
	203	#ifdef CONFIG_BT_HCIUART_MRVL
	204	int mrvl_init(void);
	205	int mrvl_deinit(void);
	206	#endif