xref: /linux/include/net/bluetooth/hci_sync.h (revision 1a371190a375f98c9b106f758ea41558c3f92556)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * BlueZ - Bluetooth protocol stack for Linux
4  *
5  * Copyright (C) 2021 Intel Corporation
6  */
7 
8 #define UINT_PTR(_handle)		((void *)((uintptr_t)_handle))
9 #define PTR_UINT(_ptr)			((uintptr_t)((void *)_ptr))
10 
11 #define HCI_REQ_DONE	  0
12 #define HCI_REQ_PEND	  1
13 #define HCI_REQ_CANCELED  2
14 
15 #define hci_req_sync_lock(hdev)   mutex_lock(&hdev->req_lock)
16 #define hci_req_sync_unlock(hdev) mutex_unlock(&hdev->req_lock)
17 
18 struct hci_request {
19 	struct hci_dev		*hdev;
20 	struct sk_buff_head	cmd_q;
21 
22 	/* If something goes wrong when building the HCI request, the error
23 	 * value is stored in this field.
24 	 */
25 	int			err;
26 };
27 
28 typedef int (*hci_cmd_sync_work_func_t)(struct hci_dev *hdev, void *data);
29 typedef void (*hci_cmd_sync_work_destroy_t)(struct hci_dev *hdev, void *data,
30 					    int err);
31 
32 struct hci_cmd_sync_work_entry {
33 	struct list_head list;
34 	hci_cmd_sync_work_func_t func;
35 	void *data;
36 	hci_cmd_sync_work_destroy_t destroy;
37 };
38 
39 struct adv_info;
40 
41 struct sk_buff *hci_cmd_sync_alloc(struct hci_dev *hdev, u16 opcode, u32 plen,
42 				   const void *param, struct sock *sk);
43 
44 /* Function with sync suffix shall not be called with hdev->lock held as they
45  * wait the command to complete and in the meantime an event could be received
46  * which could attempt to acquire hdev->lock causing a deadlock.
47  */
48 struct sk_buff *__hci_cmd_sync(struct hci_dev *hdev, u16 opcode, u32 plen,
49 			       const void *param, u32 timeout);
50 struct sk_buff *hci_cmd_sync(struct hci_dev *hdev, u16 opcode, u32 plen,
51 			     const void *param, u32 timeout);
52 struct sk_buff *__hci_cmd_sync_ev(struct hci_dev *hdev, u16 opcode, u32 plen,
53 				  const void *param, u8 event, u32 timeout);
54 struct sk_buff *__hci_cmd_sync_sk(struct hci_dev *hdev, u16 opcode, u32 plen,
55 				  const void *param, u8 event, u32 timeout,
56 				  struct sock *sk);
57 int __hci_cmd_sync_status(struct hci_dev *hdev, u16 opcode, u32 plen,
58 			  const void *param, u32 timeout);
59 int __hci_cmd_sync_status_sk(struct hci_dev *hdev, u16 opcode, u32 plen,
60 			     const void *param, u8 event, u32 timeout,
61 			     struct sock *sk);
62 int hci_cmd_sync_status(struct hci_dev *hdev, u16 opcode, u32 plen,
63 			const void *param, u32 timeout);
64 
65 void hci_cmd_sync_init(struct hci_dev *hdev);
66 void hci_cmd_sync_clear(struct hci_dev *hdev);
67 void hci_cmd_sync_cancel(struct hci_dev *hdev, int err);
68 void hci_cmd_sync_cancel_sync(struct hci_dev *hdev, int err);
69 
70 int hci_cmd_sync_submit(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
71 			void *data, hci_cmd_sync_work_destroy_t destroy);
72 int hci_cmd_sync_queue(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
73 		       void *data, hci_cmd_sync_work_destroy_t destroy);
74 int hci_cmd_sync_queue_once(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
75 			    void *data, hci_cmd_sync_work_destroy_t destroy);
76 int hci_cmd_sync_run(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
77 		     void *data, hci_cmd_sync_work_destroy_t destroy);
78 int hci_cmd_sync_run_once(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
79 			  void *data, hci_cmd_sync_work_destroy_t destroy);
80 struct hci_cmd_sync_work_entry *
81 hci_cmd_sync_lookup_entry(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
82 			  void *data, hci_cmd_sync_work_destroy_t destroy);
83 void hci_cmd_sync_cancel_entry(struct hci_dev *hdev,
84 			       struct hci_cmd_sync_work_entry *entry);
85 bool hci_cmd_sync_dequeue(struct hci_dev *hdev, hci_cmd_sync_work_func_t func,
86 			  void *data, hci_cmd_sync_work_destroy_t destroy);
87 bool hci_cmd_sync_dequeue_once(struct hci_dev *hdev,
88 			      hci_cmd_sync_work_func_t func, void *data,
89 			      hci_cmd_sync_work_destroy_t destroy);
90 
91 int hci_update_eir_sync(struct hci_dev *hdev);
92 int hci_update_class_sync(struct hci_dev *hdev);
93 
94 int hci_update_eir_sync(struct hci_dev *hdev);
95 int hci_update_class_sync(struct hci_dev *hdev);
96 int hci_update_name_sync(struct hci_dev *hdev);
97 int hci_write_ssp_mode_sync(struct hci_dev *hdev, u8 mode);
98 
99 int hci_get_random_address(struct hci_dev *hdev, bool require_privacy,
100 			   bool use_rpa, struct adv_info *adv_instance,
101 			   u8 *own_addr_type, bdaddr_t *rand_addr);
102 
103 int hci_update_random_address_sync(struct hci_dev *hdev, bool require_privacy,
104 				   bool rpa, u8 *own_addr_type);
105 
106 int hci_update_scan_rsp_data_sync(struct hci_dev *hdev, u8 instance);
107 int hci_update_adv_data_sync(struct hci_dev *hdev, u8 instance);
108 int hci_update_adv_data(struct hci_dev *hdev, u8 instance);
109 int hci_schedule_adv_instance_sync(struct hci_dev *hdev, u8 instance,
110 				   bool force);
111 
112 int hci_setup_ext_adv_instance_sync(struct hci_dev *hdev, u8 instance);
113 int hci_start_ext_adv_sync(struct hci_dev *hdev, u8 instance);
114 int hci_enable_ext_advertising_sync(struct hci_dev *hdev, u8 instance);
115 int hci_enable_advertising_sync(struct hci_dev *hdev);
116 int hci_enable_advertising(struct hci_dev *hdev);
117 
118 int hci_start_per_adv_sync(struct hci_dev *hdev, u8 instance, u8 data_len,
119 			   u8 *data, u32 flags, u16 min_interval,
120 			   u16 max_interval, u16 sync_interval);
121 
122 int hci_disable_per_advertising_sync(struct hci_dev *hdev, u8 instance);
123 
124 int hci_remove_advertising_sync(struct hci_dev *hdev, struct sock *sk,
125 				u8 instance, bool force);
126 int hci_disable_advertising_sync(struct hci_dev *hdev);
127 int hci_clear_adv_instance_sync(struct hci_dev *hdev, struct sock *sk,
128 				u8 instance, bool force);
129 int hci_update_passive_scan_sync(struct hci_dev *hdev);
130 int hci_update_passive_scan(struct hci_dev *hdev);
131 int hci_read_rssi_sync(struct hci_dev *hdev, __le16 handle);
132 int hci_read_tx_power_sync(struct hci_dev *hdev, __le16 handle, u8 type);
133 int hci_write_sc_support_sync(struct hci_dev *hdev, u8 val);
134 int hci_read_clock_sync(struct hci_dev *hdev, struct hci_cp_read_clock *cp);
135 
136 int hci_write_fast_connectable_sync(struct hci_dev *hdev, bool enable);
137 int hci_update_scan_sync(struct hci_dev *hdev);
138 int hci_update_scan(struct hci_dev *hdev);
139 
140 int hci_write_le_host_supported_sync(struct hci_dev *hdev, u8 le, u8 simul);
141 int hci_remove_ext_adv_instance_sync(struct hci_dev *hdev, u8 instance,
142 				     struct sock *sk);
143 int hci_remove_ext_adv_instance(struct hci_dev *hdev, u8 instance);
144 struct sk_buff *hci_read_local_oob_data_sync(struct hci_dev *hdev, bool ext,
145 					     struct sock *sk);
146 
147 int hci_reset_sync(struct hci_dev *hdev);
148 int hci_dev_open_sync(struct hci_dev *hdev);
149 int hci_dev_close_sync(struct hci_dev *hdev);
150 
151 int hci_powered_update_sync(struct hci_dev *hdev);
152 int hci_set_powered_sync(struct hci_dev *hdev, u8 val);
153 
154 int hci_update_discoverable_sync(struct hci_dev *hdev);
155 int hci_update_discoverable(struct hci_dev *hdev);
156 
157 int hci_update_connectable_sync(struct hci_dev *hdev);
158 
159 int hci_inquiry_sync(struct hci_dev *hdev, u8 length, u8 num_rsp);
160 
161 int hci_start_discovery_sync(struct hci_dev *hdev);
162 int hci_stop_discovery_sync(struct hci_dev *hdev);
163 
164 int hci_suspend_sync(struct hci_dev *hdev);
165 int hci_resume_sync(struct hci_dev *hdev);
166 
167 struct hci_conn;
168 struct hci_conn_params;
169 
170 int hci_abort_conn_sync(struct hci_dev *hdev, struct hci_conn *conn, u8 reason);
171 
172 int hci_le_create_cis_sync(struct hci_dev *hdev);
173 
174 int hci_le_remove_cig_sync(struct hci_dev *hdev, u8 handle);
175 
176 int hci_le_terminate_big_sync(struct hci_dev *hdev, u8 handle, u8 reason);
177 
178 int hci_le_big_terminate_sync(struct hci_dev *hdev, u8 handle);
179 
180 int hci_le_pa_terminate_sync(struct hci_dev *hdev, u16 handle);
181 
182 int hci_connect_acl_sync(struct hci_dev *hdev, struct hci_conn *conn);
183 
184 int hci_connect_le_sync(struct hci_dev *hdev, struct hci_conn *conn);
185 
186 int hci_cancel_connect_sync(struct hci_dev *hdev, struct hci_conn *conn);
187 int hci_le_conn_update_sync(struct hci_dev *hdev, struct hci_conn *conn,
188 			    struct hci_conn_params *params);
189