xref: /btstack/src/classic/avrcp_browsing_target.c (revision 119bdcb221753faaae11978428024ce0a884d662)
1 /*
2  * Copyright (C) 2016 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define BTSTACK_FILE__ "avrcp_browsing_target.c"
39 
40 #include <stdint.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <inttypes.h>
45 #include "btstack.h"
46 #include "classic/avrcp.h"
47 #include "classic/avrcp_browsing_target.h"
48 
49 #define PSM_AVCTP_BROWSING              0x001b
50 
51 static void avrcp_browser_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, avrcp_context_t * context);
52 static void avrcp_browsing_target_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
53 
54 static void avrcp_browsing_target_request_can_send_now(avrcp_browsing_connection_t * connection, uint16_t l2cap_cid){
55     connection->wait_to_send = 1;
56     l2cap_request_can_send_now_event(l2cap_cid);
57 }
58 
59 static int avrcp_browsing_target_handle_can_send_now(avrcp_browsing_connection_t * connection){
60     int pos = 0;
61     // printf("avrcp_browsing_target_handle_can_send_now, cmd_operands_length %d\n", connection->cmd_operands_length);
62     // printf_hexdump(connection->cmd_operands, connection->cmd_operands_length);
63 
64     // l2cap_reserve_packet_buffer();
65     // uint8_t * packet = l2cap_get_outgoing_buffer();
66     uint8_t packet[300];
67     connection->packet_type = AVRCP_SINGLE_PACKET;
68 
69     packet[pos++] = (connection->transaction_label << 4) | (connection->packet_type << 2) | (AVRCP_RESPONSE_FRAME << 1) | 0;
70     // Profile IDentifier (PID)
71     packet[pos++] = BLUETOOTH_SERVICE_CLASS_AV_REMOTE_CONTROL >> 8;
72     packet[pos++] = BLUETOOTH_SERVICE_CLASS_AV_REMOTE_CONTROL & 0x00FF;
73     (void)memcpy(packet + pos, connection->cmd_operands,
74                  connection->cmd_operands_length);
75 
76     pos += connection->cmd_operands_length;
77     connection->wait_to_send = 0;
78     // return l2cap_send_prepared(connection->l2cap_browsing_cid, pos);
79     return l2cap_send(connection->l2cap_browsing_cid, packet, pos);
80 }
81 
82 
83 static uint8_t avrcp_browsing_target_response_general_reject(avrcp_browsing_connection_t * connection, avrcp_status_code_t status){
84     // AVRCP_CTYPE_RESPONSE_REJECTED
85     int pos = 0;
86     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GENERAL_REJECT;
87     // connection->cmd_operands[pos++] = 0;
88     // param length
89     big_endian_store_16(connection->cmd_operands, pos, 1);
90     pos += 2;
91     connection->cmd_operands[pos++] = status;
92     connection->cmd_operands_length = 4;
93     connection->state = AVCTP_W2_SEND_RESPONSE;
94     avrcp_browsing_target_request_can_send_now(connection, connection->l2cap_browsing_cid);
95     return ERROR_CODE_SUCCESS;
96 }
97 
98 static void avrcp_browsing_target_emit_get_folder_items(btstack_packet_handler_t callback, uint16_t browsing_cid, avrcp_browsing_connection_t * connection){
99     btstack_assert(callback != NULL);
100 
101     uint8_t event[10];
102     int pos = 0;
103     event[pos++] = HCI_EVENT_AVRCP_META;
104     event[pos++] = sizeof(event) - 2;
105     event[pos++] = AVRCP_SUBEVENT_BROWSING_GET_FOLDER_ITEMS;
106     little_endian_store_16(event, pos, browsing_cid);
107     pos += 2;
108     event[pos++] = connection->scope;
109     big_endian_store_32(event, pos, connection->attr_bitmap);
110     pos += 4;
111     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
112 }
113 
114 static void avrcp_browsing_target_emit_get_total_num_items(btstack_packet_handler_t callback, uint16_t browsing_cid, avrcp_browsing_connection_t * connection){
115     btstack_assert(callback != NULL);
116 
117     uint8_t event[10];
118     int pos = 0;
119     event[pos++] = HCI_EVENT_AVRCP_META;
120     event[pos++] = sizeof(event) - 2;
121     event[pos++] = AVRCP_SUBEVENT_BROWSING_GET_TOTAL_NUM_ITEMS;
122     little_endian_store_16(event, pos, browsing_cid);
123     pos += 2;
124     event[pos++] = connection->scope;
125     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
126 }
127 
128 static void avrcp_browser_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, avrcp_context_t * context){
129     UNUSED(channel);
130     UNUSED(size);
131     bd_addr_t event_addr;
132     uint16_t local_cid;
133     uint8_t  status;
134     avrcp_browsing_connection_t * browsing_connection = NULL;
135     avrcp_connection_t * avrcp_connection = NULL;
136 
137     if (packet_type != HCI_EVENT_PACKET) return;
138 
139     switch (hci_event_packet_get_type(packet)) {
140         case HCI_EVENT_DISCONNECTION_COMPLETE:
141             avrcp_emit_browsing_connection_closed(context->browsing_avrcp_callback, 0);
142             break;
143         case L2CAP_EVENT_INCOMING_CONNECTION:
144             l2cap_event_incoming_connection_get_address(packet, event_addr);
145             local_cid = l2cap_event_incoming_connection_get_local_cid(packet);
146             avrcp_connection = get_avrcp_connection_for_bd_addr_for_role(context->role, event_addr);
147             if (!avrcp_connection) {
148                 log_error("No previously created AVRCP controller connections");
149                 l2cap_decline_connection(local_cid);
150                 break;
151             }
152             browsing_connection = avrcp_browsing_create_connection(avrcp_connection);
153             browsing_connection->l2cap_browsing_cid = local_cid;
154             browsing_connection->state = AVCTP_CONNECTION_W4_ERTM_CONFIGURATION;
155             log_info("Emit AVRCP_SUBEVENT_INCOMING_BROWSING_CONNECTION browsing_cid 0x%02x, l2cap_signaling_cid 0x%02x\n", avrcp_connection->avrcp_browsing_cid, browsing_connection->l2cap_browsing_cid);
156             avrcp_emit_incoming_browsing_connection(context->browsing_avrcp_callback, avrcp_connection->avrcp_browsing_cid, event_addr);
157             break;
158 
159         case L2CAP_EVENT_CHANNEL_OPENED:
160             l2cap_event_channel_opened_get_address(packet, event_addr);
161             status = l2cap_event_channel_opened_get_status(packet);
162             local_cid = l2cap_event_channel_opened_get_local_cid(packet);
163 
164             avrcp_connection = get_avrcp_connection_for_bd_addr_for_role(context->role, event_addr);
165             if (!avrcp_connection){
166                 log_error("Failed to find AVRCP connection for bd_addr %s", bd_addr_to_str(event_addr));
167                 avrcp_emit_browsing_connection_established(context->browsing_avrcp_callback, local_cid, event_addr, L2CAP_LOCAL_CID_DOES_NOT_EXIST);
168                 l2cap_disconnect(local_cid, 0); // reason isn't used
169                 break;
170             }
171 
172             browsing_connection = avrcp_connection->browsing_connection;
173             if (status != ERROR_CODE_SUCCESS){
174                 log_info("L2CAP connection to connection %s failed. status code 0x%02x", bd_addr_to_str(event_addr), status);
175                 avrcp_emit_browsing_connection_established(context->browsing_avrcp_callback, avrcp_connection->avrcp_browsing_cid, event_addr, status);
176                 btstack_memory_avrcp_browsing_connection_free(browsing_connection);
177                 avrcp_connection->browsing_connection = NULL;
178                 break;
179             }
180             if (browsing_connection->state != AVCTP_CONNECTION_W4_L2CAP_CONNECTED) break;
181 
182             browsing_connection->l2cap_browsing_cid = local_cid;
183 
184             log_info("L2CAP_EVENT_CHANNEL_OPENED browsing cid 0x%02x, l2cap cid 0x%02x", avrcp_connection->avrcp_browsing_cid, browsing_connection->l2cap_browsing_cid);
185             browsing_connection->state = AVCTP_CONNECTION_OPENED;
186             avrcp_emit_browsing_connection_established(context->browsing_avrcp_callback, avrcp_connection->avrcp_browsing_cid, event_addr, ERROR_CODE_SUCCESS);
187             break;
188 
189         case L2CAP_EVENT_CHANNEL_CLOSED:
190             local_cid = l2cap_event_channel_closed_get_local_cid(packet);
191             avrcp_connection = get_avrcp_connection_for_browsing_l2cap_cid_for_role(context->role, local_cid);
192 
193             if (avrcp_connection && avrcp_connection->browsing_connection){
194                 avrcp_emit_browsing_connection_closed(context->browsing_avrcp_callback, avrcp_connection->avrcp_browsing_cid);
195                 // free connection
196                 btstack_memory_avrcp_browsing_connection_free(avrcp_connection->browsing_connection);
197                 avrcp_connection->browsing_connection = NULL;
198                 break;
199             }
200             break;
201         default:
202             break;
203     }
204 }
205 
206 
207 static void avrcp_browsing_target_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
208     avrcp_browsing_connection_t * browsing_connection;
209 
210     switch (packet_type) {
211         case L2CAP_DATA_PACKET:{
212             browsing_connection = get_avrcp_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
213             if (!browsing_connection) break;
214             int pos = 0;
215             uint8_t transport_header = packet[pos++];
216             // Transaction label | Packet_type | C/R | IPID (1 == invalid profile identifier)
217             browsing_connection->transaction_label = transport_header >> 4;
218             avrcp_packet_type_t avctp_packet_type = (transport_header & 0x0F) >> 2;
219             switch (avctp_packet_type){
220                 case AVRCP_SINGLE_PACKET:
221                 case AVRCP_START_PACKET:
222                     browsing_connection->subunit_type = packet[pos++] >> 2;
223                     browsing_connection->subunit_id = 0;
224                     browsing_connection->command_opcode = packet[pos++];
225                     browsing_connection->num_packets = 1;
226                     if (avctp_packet_type == AVRCP_START_PACKET){
227                         browsing_connection->num_packets = packet[pos++];
228                     }
229                     browsing_connection->pdu_id = packet[pos++];
230                     break;
231                 default:
232                     break;
233             }
234             switch (avctp_packet_type){
235                 case AVRCP_SINGLE_PACKET:
236                 case AVRCP_END_PACKET:
237                     switch(browsing_connection->pdu_id){
238                         case AVRCP_PDU_ID_GET_FOLDER_ITEMS:
239                             printf("\n");
240                             browsing_connection->scope = packet[pos++];
241                             browsing_connection->start_item = big_endian_read_32(packet, pos);
242                             pos += 4;
243                             browsing_connection->end_item = big_endian_read_32(packet, pos);
244                             pos += 4;
245                             uint8_t attr_count = packet[pos++];
246 
247                             while (attr_count){
248                                 uint32_t attr_id = big_endian_read_32(packet, pos);
249                                 pos += 4;
250                                 browsing_connection->attr_bitmap |= (1 << attr_id);
251                                 attr_count--;
252                             }
253                             avrcp_browsing_target_emit_get_folder_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
254                             break;
255                         case AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS:{
256                             // send total num items
257                             browsing_connection->scope = packet[pos++];
258                             avrcp_browsing_target_emit_get_total_num_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
259                             break;
260                         }
261                         default:
262                             avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
263                             log_info(" not parsed pdu ID 0x%02x", browsing_connection->pdu_id);
264                             break;
265                     }
266                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
267                     break;
268                 default:
269                     break;
270             }
271             break;
272         }
273 
274         case HCI_EVENT_PACKET:
275             switch (hci_event_packet_get_type(packet)){
276                 case L2CAP_EVENT_CAN_SEND_NOW:
277                     browsing_connection = get_avrcp_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
278                     if (!browsing_connection) break;
279                     if (browsing_connection->state != AVCTP_W2_SEND_RESPONSE) return;
280                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
281                     avrcp_browsing_target_handle_can_send_now(browsing_connection);
282                     break;
283                 default:
284                     avrcp_browser_packet_handler(packet_type, channel, packet, size, &avrcp_target_context);
285                     break;
286             }
287             break;
288 
289         default:
290             break;
291     }
292 }
293 
294 void avrcp_browsing_target_init(void){
295     avrcp_target_context.browsing_packet_handler = avrcp_browsing_target_packet_handler;
296     l2cap_register_service(&avrcp_browsing_target_packet_handler, PSM_AVCTP_BROWSING, 0xffff, gap_get_security_level());
297 }
298 
299 void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t callback){
300     btstack_assert(callback != NULL);
301     avrcp_target_context.browsing_avrcp_callback = callback;
302 }
303 
304 uint8_t avrcp_browsing_target_connect(bd_addr_t bd_addr, uint8_t * ertm_buffer, uint32_t size, l2cap_ertm_config_t * ertm_config, uint16_t * avrcp_browsing_cid){
305     return avrcp_browsing_connect(bd_addr, AVRCP_TARGET, avrcp_browsing_target_packet_handler, ertm_buffer, size, ertm_config, avrcp_browsing_cid);
306 }
307 
308 uint8_t avrcp_browsing_target_disconnect(uint16_t avrcp_browsing_cid){
309     return avrcp_browsing_disconnect(avrcp_browsing_cid, AVRCP_TARGET);
310 }
311 
312 uint8_t avrcp_browsing_target_configure_incoming_connection(uint16_t avrcp_browsing_cid, uint8_t * ertm_buffer, uint32_t size, l2cap_ertm_config_t * ertm_config){
313     avrcp_connection_t * avrcp_connection = get_avrcp_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
314     if (!avrcp_connection){
315         log_error("avrcp_browsing_decline_incoming_connection: could not find a connection.");
316         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
317     }
318     if (!avrcp_connection->browsing_connection){
319         log_error("avrcp_browsing_decline_incoming_connection: no browsing connection.");
320         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
321     }
322 
323     if (avrcp_connection->browsing_connection->state != AVCTP_CONNECTION_W4_ERTM_CONFIGURATION){
324         log_error("avrcp_browsing_decline_incoming_connection: browsing connection in a wrong state.");
325         return ERROR_CODE_COMMAND_DISALLOWED;
326     }
327 
328     avrcp_connection->browsing_connection->state = AVCTP_CONNECTION_W4_L2CAP_CONNECTED;
329     avrcp_connection->browsing_connection->ertm_buffer = ertm_buffer;
330     avrcp_connection->browsing_connection->ertm_buffer_size = size;
331     (void)memcpy(&avrcp_connection->browsing_connection->ertm_config,
332                  ertm_config, sizeof(l2cap_ertm_config_t));
333     l2cap_accept_ertm_connection(avrcp_connection->browsing_connection->l2cap_browsing_cid, &avrcp_connection->browsing_connection->ertm_config, avrcp_connection->browsing_connection->ertm_buffer, avrcp_connection->browsing_connection->ertm_buffer_size);
334     return ERROR_CODE_SUCCESS;
335 }
336 
337 uint8_t avrcp_browsing_target_decline_incoming_connection(uint16_t avrcp_browsing_cid){
338     avrcp_connection_t * avrcp_connection = get_avrcp_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
339     if (!avrcp_connection){
340         log_error("avrcp_browsing_decline_incoming_connection: could not find a connection.");
341         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
342     }
343     if (!avrcp_connection->browsing_connection) return ERROR_CODE_SUCCESS;
344     if (avrcp_connection->browsing_connection->state > AVCTP_CONNECTION_W4_ERTM_CONFIGURATION) return ERROR_CODE_COMMAND_DISALLOWED;
345 
346     l2cap_decline_connection(avrcp_connection->browsing_connection->l2cap_browsing_cid);
347     // free connection
348     btstack_memory_avrcp_browsing_connection_free(avrcp_connection->browsing_connection);
349     avrcp_connection->browsing_connection = NULL;
350     return ERROR_CODE_SUCCESS;
351 }
352 
353 uint8_t avrcp_subevent_browsing_get_folder_items_response(uint16_t avrcp_browsing_cid, uint16_t uid_counter, uint8_t * attr_list, uint16_t attr_list_size){
354     avrcp_connection_t * avrcp_connection = get_avrcp_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
355     if (!avrcp_connection){
356         log_error("avrcp_browsing_controller_disconnect: could not find a connection.");
357         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
358     }
359 
360     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
361     if (!connection){
362         log_info("avrcp_subevent_browsing_get_folder_items_response: could not find a connection.");
363         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
364     }
365     if (connection->state != AVCTP_CONNECTION_OPENED) return ERROR_CODE_COMMAND_DISALLOWED;
366 
367     if (connection->state != AVCTP_CONNECTION_OPENED) {
368         log_info("avrcp_subevent_browsing_get_folder_items_response: wrong state.");
369         return ERROR_CODE_COMMAND_DISALLOWED;
370     }
371     int pos = 0;
372 
373     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_FOLDER_ITEMS;
374     big_endian_store_16(connection->cmd_operands, pos, attr_list_size);
375     pos += 2;
376 
377     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
378     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
379     pos += 2;
380 
381     // TODO: fragmentation
382     if (attr_list_size >  sizeof(connection->cmd_operands)){
383         connection->attr_list = attr_list;
384         connection->attr_list_size = attr_list_size;
385         log_info(" todo: list too big, invoke fragmentation");
386         return 1;
387     }
388     (void)memcpy(&connection->cmd_operands[pos], attr_list, attr_list_size);
389     pos += attr_list_size;
390     connection->cmd_operands_length = pos;
391     // printf_hexdump(connection->cmd_operands, connection->cmd_operands_length);
392 
393     connection->state = AVCTP_W2_SEND_RESPONSE;
394     avrcp_browsing_target_request_can_send_now(connection, connection->l2cap_browsing_cid);
395     return ERROR_CODE_SUCCESS;
396 }
397 
398 
399 uint8_t avrcp_subevent_browsing_get_total_num_items_response(uint16_t avrcp_browsing_cid, uint16_t uid_counter, uint32_t total_num_items){
400     avrcp_connection_t * avrcp_connection = get_avrcp_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
401     if (!avrcp_connection){
402         log_error("avrcp_browsing_controller_disconnect: could not find a connection.");
403         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
404     }
405 
406     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
407     if (!connection){
408         log_info("avrcp_subevent_browsing_get_folder_items_response: could not find a connection.");
409         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
410     }
411     if (connection->state != AVCTP_CONNECTION_OPENED) return ERROR_CODE_COMMAND_DISALLOWED;
412 
413     if (connection->state != AVCTP_CONNECTION_OPENED) {
414         log_info("avrcp_subevent_browsing_get_folder_items_response: wrong state.");
415         return ERROR_CODE_COMMAND_DISALLOWED;
416     }
417 
418     int pos = 0;
419     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS;
420     big_endian_store_16(connection->cmd_operands, pos, 7);
421     pos += 2;
422     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
423     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
424     pos += 2;
425     big_endian_store_32(connection->cmd_operands, pos, total_num_items);
426     pos += 4;
427     connection->cmd_operands_length = pos;
428 
429     connection->state = AVCTP_W2_SEND_RESPONSE;
430     avrcp_browsing_target_request_can_send_now(connection, connection->l2cap_browsing_cid);
431     return ERROR_CODE_SUCCESS;
432 }
433 
434