[mirror_ubuntu-eoan-kernel.git] / net / nfc / llcp.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2011  Intel Corporation. All rights reserved.
 */

enum llcp_state {
	LLCP_CONNECTED = 1, /* wait_for_packet() wants that */
	LLCP_CONNECTING,
	LLCP_DISCONNECTING,
	LLCP_CLOSED,
	LLCP_BOUND,
	LLCP_LISTEN,
};

#define LLCP_DEFAULT_LTO 100
#define LLCP_DEFAULT_RW  1
#define LLCP_DEFAULT_MIU 128

#define LLCP_MAX_LTO  0xff
#define LLCP_MAX_RW   15
#define LLCP_MAX_MIUX 0x7ff
#define LLCP_MAX_MIU (LLCP_MAX_MIUX + 128)

#define LLCP_WKS_NUM_SAP   16
#define LLCP_SDP_NUM_SAP   16
#define LLCP_LOCAL_NUM_SAP 32
#define LLCP_LOCAL_SAP_OFFSET (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP)
#define LLCP_MAX_SAP (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP + LLCP_LOCAL_NUM_SAP)
#define LLCP_SDP_UNBOUND   (LLCP_MAX_SAP + 1)

struct nfc_llcp_sock;

struct llcp_sock_list {
	struct hlist_head head;
	rwlock_t          lock;
};

struct nfc_llcp_sdp_tlv {
	u8 *tlv;
	u8 tlv_len;

	char *uri;
	u8 tid;
	u8 sap;

	unsigned long time;

	struct hlist_node node;
};

struct nfc_llcp_local {
	struct list_head list;
	struct nfc_dev *dev;

	struct kref ref;

	struct mutex sdp_lock;

	struct timer_list link_timer;
	struct sk_buff_head tx_queue;
	struct work_struct	 tx_work;
	struct work_struct	 rx_work;
	struct sk_buff *rx_pending;
	struct work_struct	 timeout_work;

	u32 target_idx;
	u8 rf_mode;
	u8 comm_mode;
	u8 lto;
	u8 rw;
	__be16 miux;
	unsigned long local_wks;      /* Well known services */
	unsigned long local_sdp;      /* Local services  */
	unsigned long local_sap; /* Local SAPs, not available for discovery */
	atomic_t local_sdp_cnt[LLCP_SDP_NUM_SAP];

	/* local */
	u8 gb[NFC_MAX_GT_LEN];
	u8 gb_len;

	/* remote */
	u8 remote_gb[NFC_MAX_GT_LEN];
	u8 remote_gb_len;

	u8  remote_version;
	u16 remote_miu;
	u16 remote_lto;
	u8  remote_opt;
	u16 remote_wks;

	struct mutex sdreq_lock;
	struct hlist_head pending_sdreqs;
	struct timer_list sdreq_timer;
	struct work_struct sdreq_timeout_work;
	u8 sdreq_next_tid;

	/* sockets array */
	struct llcp_sock_list sockets;
	struct llcp_sock_list connecting_sockets;
	struct llcp_sock_list raw_sockets;
};

struct nfc_llcp_sock {
	struct sock sk;
	struct nfc_dev *dev;
	struct nfc_llcp_local *local;
	u32 target_idx;
	u32 nfc_protocol;

	/* Link parameters */
	u8 ssap;
	u8 dsap;
	char *service_name;
	size_t service_name_len;
	u8 rw;
	__be16 miux;


	/* Remote link parameters */
	u8 remote_rw;
	u16 remote_miu;

	/* Link variables */
	u8 send_n;
	u8 send_ack_n;
	u8 recv_n;
	u8 recv_ack_n;

	/* Is the remote peer ready to receive */
	u8 remote_ready;

	/* Reserved source SAP */
	u8 reserved_ssap;

	struct sk_buff_head tx_queue;
	struct sk_buff_head tx_pending_queue;

	struct list_head accept_queue;
	struct sock *parent;
};

struct nfc_llcp_ui_cb {
	__u8 dsap;
	__u8 ssap;
};

#define nfc_llcp_ui_skb_cb(__skb) ((struct nfc_llcp_ui_cb *)&((__skb)->cb[0]))

#define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
#define nfc_llcp_dev(sk)  (nfc_llcp_sock((sk))->dev)

#define LLCP_HEADER_SIZE   2
#define LLCP_SEQUENCE_SIZE 1
#define LLCP_AGF_PDU_HEADER_SIZE 2

/* LLCP versions: 1.1 is 1.0 plus SDP */
#define LLCP_VERSION_10 0x10
#define LLCP_VERSION_11 0x11

/* LLCP PDU types */
#define LLCP_PDU_SYMM     0x0
#define LLCP_PDU_PAX      0x1
#define LLCP_PDU_AGF      0x2
#define LLCP_PDU_UI       0x3
#define LLCP_PDU_CONNECT  0x4
#define LLCP_PDU_DISC     0x5
#define LLCP_PDU_CC       0x6
#define LLCP_PDU_DM       0x7
#define LLCP_PDU_FRMR     0x8
#define LLCP_PDU_SNL      0x9
#define LLCP_PDU_I        0xc
#define LLCP_PDU_RR       0xd
#define LLCP_PDU_RNR      0xe

/* Parameters TLV types */
#define LLCP_TLV_VERSION 0x1
#define LLCP_TLV_MIUX    0x2
#define LLCP_TLV_WKS     0x3
#define LLCP_TLV_LTO     0x4
#define LLCP_TLV_RW      0x5
#define LLCP_TLV_SN      0x6
#define LLCP_TLV_OPT     0x7
#define LLCP_TLV_SDREQ   0x8
#define LLCP_TLV_SDRES   0x9
#define LLCP_TLV_MAX     0xa

/* Well known LLCP SAP */
#define LLCP_SAP_SDP   0x1
#define LLCP_SAP_IP    0x2
#define LLCP_SAP_OBEX  0x3
#define LLCP_SAP_SNEP  0x4
#define LLCP_SAP_MAX   0xff

/* Disconnection reason code */
#define LLCP_DM_DISC    0x00
#define LLCP_DM_NOCONN  0x01
#define LLCP_DM_NOBOUND 0x02
#define LLCP_DM_REJ     0x03


void nfc_llcp_sock_link(struct llcp_sock_list *l, struct sock *s);
void nfc_llcp_sock_unlink(struct llcp_sock_list *l, struct sock *s);
void nfc_llcp_socket_remote_param_init(struct nfc_llcp_sock *sock);
struct nfc_llcp_local *nfc_llcp_find_local(struct nfc_dev *dev);
struct nfc_llcp_local *nfc_llcp_local_get(struct nfc_llcp_local *local);
int nfc_llcp_local_put(struct nfc_llcp_local *local);
u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
			 struct nfc_llcp_sock *sock);
u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
void nfc_llcp_send_to_raw_sock(struct nfc_llcp_local *local,
			       struct sk_buff *skb, u8 direction);

/* Sock API */
struct sock *nfc_llcp_sock_alloc(struct socket *sock, int type, gfp_t gfp, int kern);
void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
void nfc_llcp_accept_unlink(struct sock *sk);
void nfc_llcp_accept_enqueue(struct sock *parent, struct sock *sk);
struct sock *nfc_llcp_accept_dequeue(struct sock *sk, struct socket *newsock);

/* TLV API */
int nfc_llcp_parse_gb_tlv(struct nfc_llcp_local *local,
			  u8 *tlv_array, u16 tlv_array_len);
int nfc_llcp_parse_connection_tlv(struct nfc_llcp_sock *sock,
				  u8 *tlv_array, u16 tlv_array_len);

/* Commands API */
void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
u8 *nfc_llcp_build_tlv(u8 type, u8 *value, u8 value_length, u8 *tlv_length);
struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdres_tlv(u8 tid, u8 sap);
struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdreq_tlv(u8 tid, char *uri,
						  size_t uri_len);
void nfc_llcp_free_sdp_tlv(struct nfc_llcp_sdp_tlv *sdp);
void nfc_llcp_free_sdp_tlv_list(struct hlist_head *sdp_head);
void nfc_llcp_recv(void *data, struct sk_buff *skb, int err);
int nfc_llcp_send_symm(struct nfc_dev *dev);
int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
int nfc_llcp_send_snl_sdres(struct nfc_llcp_local *local,
			    struct hlist_head *tlv_list, size_t tlvs_len);
int nfc_llcp_send_snl_sdreq(struct nfc_llcp_local *local,
			    struct hlist_head *tlv_list, size_t tlvs_len);
int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
			  struct msghdr *msg, size_t len);
int nfc_llcp_send_ui_frame(struct nfc_llcp_sock *sock, u8 ssap, u8 dsap,
			   struct msghdr *msg, size_t len);
int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);

/* Socket API */
int __init nfc_llcp_sock_init(void);
void nfc_llcp_sock_exit(void);
Commit	Line	Data
1ccea77e	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
d646960f SO	2	/*
d646960f SO	3	* Copyright (C) 2011 Intel Corporation. All rights reserved.
d646960f SO	4	*/
	5
	6	enum llcp_state {
	7	LLCP_CONNECTED = 1, /* wait_for_packet() wants that */
b4011239	8	LLCP_CONNECTING,
17f7ae16	9	LLCP_DISCONNECTING,
d646960f SO	10	LLCP_CLOSED,
	11	LLCP_BOUND,
	12	LLCP_LISTEN,
	13	};
	14
	15	#define LLCP_DEFAULT_LTO 100
	16	#define LLCP_DEFAULT_RW 1
	17	#define LLCP_DEFAULT_MIU 128
	18
eda21f16 SO	19	#define LLCP_MAX_LTO 0xff
	20	#define LLCP_MAX_RW 15
	21	#define LLCP_MAX_MIUX 0x7ff
66cbfa10	22	#define LLCP_MAX_MIU (LLCP_MAX_MIUX + 128)
eda21f16	23
d646960f SO	24	#define LLCP_WKS_NUM_SAP 16
	25	#define LLCP_SDP_NUM_SAP 16
	26	#define LLCP_LOCAL_NUM_SAP 32
	27	#define LLCP_LOCAL_SAP_OFFSET (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP)
	28	#define LLCP_MAX_SAP (LLCP_WKS_NUM_SAP + LLCP_SDP_NUM_SAP + LLCP_LOCAL_NUM_SAP)
8f50020e	29	#define LLCP_SDP_UNBOUND (LLCP_MAX_SAP + 1)
d646960f SO	30
	31	struct nfc_llcp_sock;
	32
a69f32af SO	33	struct llcp_sock_list {
	34	struct hlist_head head;
	35	rwlock_t lock;
	36	};
	37
e0ae7bac TE	38	struct nfc_llcp_sdp_tlv {
	39	u8 *tlv;
	40	u8 tlv_len;
	41
	42	char *uri;
	43	u8 tid;
	44	u8 sap;
	45
40213fa8 TE	46	unsigned long time;
40213fa8 TE	47
e0ae7bac TE	48	struct hlist_node node;
	49	};
	50
d646960f SO	51	struct nfc_llcp_local {
	52	struct list_head list;
	53	struct nfc_dev *dev;
	54
c7aa1225 SO	55	struct kref ref;
c7aa1225 SO	56
d646960f	57	struct mutex sdp_lock;
d646960f SO	58
	59	struct timer_list link_timer;
	60	struct sk_buff_head tx_queue;
d646960f	61	struct work_struct tx_work;
d646960f SO	62	struct work_struct rx_work;
d646960f SO	63	struct sk_buff *rx_pending;
d646960f SO	64	struct work_struct timeout_work;
	65
	66	u32 target_idx;
	67	u8 rf_mode;
	68	u8 comm_mode;
52feb444 TE	69	u8 lto;
	70	u8 rw;
	71	__be16 miux;
d646960f SO	72	unsigned long local_wks; /* Well known services */
	73	unsigned long local_sdp; /* Local services */
	74	unsigned long local_sap; /* Local SAPs, not available for discovery */
8f50020e	75	atomic_t local_sdp_cnt[LLCP_SDP_NUM_SAP];
d646960f SO	76
	77	/* local */
	78	u8 gb[NFC_MAX_GT_LEN];
	79	u8 gb_len;
	80
	81	/* remote */
	82	u8 remote_gb[NFC_MAX_GT_LEN];
	83	u8 remote_gb_len;
	84
	85	u8 remote_version;
	86	u16 remote_miu;
	87	u16 remote_lto;
	88	u8 remote_opt;
	89	u16 remote_wks;
d646960f	90
d9b8d8e1 TE	91	struct mutex sdreq_lock;
d9b8d8e1 TE	92	struct hlist_head pending_sdreqs;
40213fa8 TE	93	struct timer_list sdreq_timer;
40213fa8 TE	94	struct work_struct sdreq_timeout_work;
d9b8d8e1 TE	95	u8 sdreq_next_tid;
d9b8d8e1 TE	96
d646960f	97	/* sockets array */
a69f32af SO	98	struct llcp_sock_list sockets;
a69f32af SO	99	struct llcp_sock_list connecting_sockets;
4463523b	100	struct llcp_sock_list raw_sockets;
d646960f SO	101	};
	102
	103	struct nfc_llcp_sock {
	104	struct sock sk;
d646960f SO	105	struct nfc_dev *dev;
	106	struct nfc_llcp_local *local;
	107	u32 target_idx;
	108	u32 nfc_protocol;
	109
7a06e586	110	/* Link parameters */
d646960f SO	111	u8 ssap;
	112	u8 dsap;
	113	char *service_name;
	114	size_t service_name_len;
26fd76ca	115	u8 rw;
5eef6669	116	__be16 miux;
26fd76ca	117
e4306bec SO	118
	119	/* Remote link parameters */
	120	u8 remote_rw;
	121	u16 remote_miu;
d646960f SO	122
	123	/* Link variables */
	124	u8 send_n;
	125	u8 send_ack_n;
	126	u8 recv_n;
	127	u8 recv_ack_n;
	128
	129	/* Is the remote peer ready to receive */
	130	u8 remote_ready;
	131
cbbf4721 SO	132	/* Reserved source SAP */
	133	u8 reserved_ssap;
	134
d646960f SO	135	struct sk_buff_head tx_queue;
d646960f SO	136	struct sk_buff_head tx_pending_queue;
d646960f SO	137
	138	struct list_head accept_queue;
	139	struct sock *parent;
	140	};
	141
968272bf SO	142	struct nfc_llcp_ui_cb {
	143	__u8 dsap;
	144	__u8 ssap;
	145	};
	146
	147	#define nfc_llcp_ui_skb_cb(__skb) ((struct nfc_llcp_ui_cb *)&((__skb)->cb[0]))
	148
d646960f SO	149	#define nfc_llcp_sock(sk) ((struct nfc_llcp_sock *) (sk))
	150	#define nfc_llcp_dev(sk) (nfc_llcp_sock((sk))->dev)
	151
	152	#define LLCP_HEADER_SIZE 2
	153	#define LLCP_SEQUENCE_SIZE 1
098dafcf	154	#define LLCP_AGF_PDU_HEADER_SIZE 2
d646960f SO	155
	156	/* LLCP versions: 1.1 is 1.0 plus SDP */
	157	#define LLCP_VERSION_10 0x10
	158	#define LLCP_VERSION_11 0x11
	159
	160	/* LLCP PDU types */
	161	#define LLCP_PDU_SYMM 0x0
	162	#define LLCP_PDU_PAX 0x1
	163	#define LLCP_PDU_AGF 0x2
	164	#define LLCP_PDU_UI 0x3
	165	#define LLCP_PDU_CONNECT 0x4
	166	#define LLCP_PDU_DISC 0x5
	167	#define LLCP_PDU_CC 0x6
	168	#define LLCP_PDU_DM 0x7
	169	#define LLCP_PDU_FRMR 0x8
	170	#define LLCP_PDU_SNL 0x9
	171	#define LLCP_PDU_I 0xc
	172	#define LLCP_PDU_RR 0xd
	173	#define LLCP_PDU_RNR 0xe
	174
	175	/* Parameters TLV types */
	176	#define LLCP_TLV_VERSION 0x1
	177	#define LLCP_TLV_MIUX 0x2
	178	#define LLCP_TLV_WKS 0x3
	179	#define LLCP_TLV_LTO 0x4
	180	#define LLCP_TLV_RW 0x5
	181	#define LLCP_TLV_SN 0x6
	182	#define LLCP_TLV_OPT 0x7
	183	#define LLCP_TLV_SDREQ 0x8
	184	#define LLCP_TLV_SDRES 0x9
	185	#define LLCP_TLV_MAX 0xa
	186
	187	/* Well known LLCP SAP */
	188	#define LLCP_SAP_SDP 0x1
	189	#define LLCP_SAP_IP 0x2
	190	#define LLCP_SAP_OBEX 0x3
	191	#define LLCP_SAP_SNEP 0x4
	192	#define LLCP_SAP_MAX 0xff
	193
	194	/* Disconnection reason code */
	195	#define LLCP_DM_DISC 0x00
	196	#define LLCP_DM_NOCONN 0x01
	197	#define LLCP_DM_NOBOUND 0x02
	198	#define LLCP_DM_REJ 0x03
	199
	200
a69f32af SO	201	void nfc_llcp_sock_link(struct llcp_sock_list l, struct sock s);
a69f32af SO	202	void nfc_llcp_sock_unlink(struct llcp_sock_list l, struct sock s);
abd18d43	203	void nfc_llcp_socket_remote_param_init(struct nfc_llcp_sock *sock);
d646960f	204	struct nfc_llcp_local nfc_llcp_find_local(struct nfc_dev dev);
c7aa1225 SO	205	struct nfc_llcp_local nfc_llcp_local_get(struct nfc_llcp_local local);
c7aa1225 SO	206	int nfc_llcp_local_put(struct nfc_llcp_local *local);
d646960f	207	u8 nfc_llcp_get_sdp_ssap(struct nfc_llcp_local *local,
427a2eb1	208	struct nfc_llcp_sock *sock);
d646960f SO	209	u8 nfc_llcp_get_local_ssap(struct nfc_llcp_local *local);
d646960f SO	210	void nfc_llcp_put_ssap(struct nfc_llcp_local *local, u8 ssap);
d094afa1	211	int nfc_llcp_queue_i_frames(struct nfc_llcp_sock *sock);
4463523b TE	212	void nfc_llcp_send_to_raw_sock(struct nfc_llcp_local *local,
4463523b TE	213	struct sk_buff *skb, u8 direction);
d646960f SO	214
d646960f SO	215	/* Sock API */
11aa9c28	216	struct sock nfc_llcp_sock_alloc(struct socket sock, int type, gfp_t gfp, int kern);
d646960f SO	217	void nfc_llcp_sock_free(struct nfc_llcp_sock *sock);
	218	void nfc_llcp_accept_unlink(struct sock *sk);
	219	void nfc_llcp_accept_enqueue(struct sock parent, struct sock sk);
	220	struct sock nfc_llcp_accept_dequeue(struct sock sk, struct socket *newsock);
	221
	222	/* TLV API */
7a06e586 SO	223	int nfc_llcp_parse_gb_tlv(struct nfc_llcp_local *local,
	224	u8 *tlv_array, u16 tlv_array_len);
	225	int nfc_llcp_parse_connection_tlv(struct nfc_llcp_sock *sock,
	226	u8 *tlv_array, u16 tlv_array_len);
d646960f SO	227
	228	/* Commands API */
	229	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
	230	u8 nfc_llcp_build_tlv(u8 type, u8 value, u8 value_length, u8 *tlv_length);
e0ae7bac	231	struct nfc_llcp_sdp_tlv *nfc_llcp_build_sdres_tlv(u8 tid, u8 sap);
d9b8d8e1 TE	232	struct nfc_llcp_sdp_tlv nfc_llcp_build_sdreq_tlv(u8 tid, char uri,
d9b8d8e1 TE	233	size_t uri_len);
e0ae7bac	234	void nfc_llcp_free_sdp_tlv(struct nfc_llcp_sdp_tlv *sdp);
d9b8d8e1	235	void nfc_llcp_free_sdp_tlv_list(struct hlist_head *sdp_head);
d646960f	236	void nfc_llcp_recv(void data, struct sk_buff skb, int err);
d646960f SO	237	int nfc_llcp_send_symm(struct nfc_dev *dev);
	238	int nfc_llcp_send_connect(struct nfc_llcp_sock *sock);
	239	int nfc_llcp_send_cc(struct nfc_llcp_sock *sock);
e0ae7bac TE	240	int nfc_llcp_send_snl_sdres(struct nfc_llcp_local *local,
e0ae7bac TE	241	struct hlist_head *tlv_list, size_t tlvs_len);
d9b8d8e1 TE	242	int nfc_llcp_send_snl_sdreq(struct nfc_llcp_local *local,
d9b8d8e1 TE	243	struct hlist_head *tlv_list, size_t tlvs_len);
d646960f SO	244	int nfc_llcp_send_dm(struct nfc_llcp_local *local, u8 ssap, u8 dsap, u8 reason);
d646960f SO	245	int nfc_llcp_send_disconnect(struct nfc_llcp_sock *sock);
53a0ac2e	246	int nfc_llcp_send_i_frame(struct nfc_llcp_sock *sock,
427a2eb1	247	struct msghdr *msg, size_t len);
94f418a2 SO	248	int nfc_llcp_send_ui_frame(struct nfc_llcp_sock *sock, u8 ssap, u8 dsap,
94f418a2 SO	249	struct msghdr *msg, size_t len);
d094afa1	250	int nfc_llcp_send_rr(struct nfc_llcp_sock *sock);
d646960f SO	251
	252	/* Socket API */
	253	int __init nfc_llcp_sock_init(void);
	254	void nfc_llcp_sock_exit(void);