xref: /btstack/src/classic/avrcp_browsing.h (revision 665a00cb2a19afbc8656616d55848cad7bec956a)
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 /*
39  * avrcp_browsing.h
40  *
41  * Audio/Video Remote Control Profile (Browsing)
42  *
43  */
44 
45 #ifndef AVRCP_BROWSING_H
46 #define AVRCP_BROWSING_H
47 
48 #include <stdint.h>
49 #include "avrcp.h"
50 #include "btstack_run_loop.h"
51 #include "btstack_linked_list.h"
52 #include "l2cap.h"
53 
54 #if defined __cplusplus
55 extern "C" {
56 #endif
57 
58 avrcp_connection_t *          get_avrcp_connection_for_browsing_cid_for_role(avrcp_role_t role, uint16_t browsing_cid);
59 avrcp_connection_t *          get_avrcp_connection_for_browsing_l2cap_cid_for_role(avrcp_role_t role, uint16_t browsing_l2cap_cid);
60 avrcp_browsing_connection_t * get_avrcp_browsing_connection_for_l2cap_cid_for_role(avrcp_role_t role, uint16_t l2cap_cid);
61 
62 void avrcp_browsing_register_controller_packet_handler(btstack_packet_handler_t callback);
63 void avrcp_browsing_register_target_packet_handler(btstack_packet_handler_t callback);
64 void avrcp_browsing_request_can_send_now(avrcp_browsing_connection_t * connection, uint16_t l2cap_cid);
65 
66 /* API_START */
67 /**
68  * @brief Set up AVRCP Browsing service
69  */
70 void avrcp_browsing_init(void);
71 
72 /**
73  * @brief Register callback for the AVRCP Browsing Controller client.
74  * @param callback
75  */
76 void avrcp_browsing_register_packet_handler(btstack_packet_handler_t callback);
77 
78 /**
79  * @brief   Connect to AVRCP Browsing service on a remote device, emits AVRCP_SUBEVENT_BROWSING_CONNECTION_ESTABLISHED with status
80  * @param   remote_addr
81  * @param   ertm_buffer
82  * @param   ertm_buffer_size
83  * @param   ertm_config
84  * @param   avrcp_browsing_cid  outgoing parameter, valid if status == ERROR_CODE_SUCCESS
85  * @returns status
86  */
87 uint8_t avrcp_browsing_connect(bd_addr_t remote_addr, uint8_t * ertm_buffer, uint32_t ertm_buffer_size, l2cap_ertm_config_t * ertm_config, uint16_t * avrcp_browsing_cid);
88 
89 /**
90  * @brief Configure incoming connection for Browsing Service.
91  * @param avrcp_browsing_cid
92  * @param ertm_buffer
93  * @param ertm_buffer_size
94  * @param ertm_config
95  * @returns status
96  */
97 uint8_t avrcp_browsing_configure_incoming_connection(uint16_t avrcp_browsing_cid, uint8_t * ertm_buffer, uint32_t ertm_buffer_size, l2cap_ertm_config_t * ertm_config);
98 
99 /**
100  * @brief Decline incoming connection Browsing Service.
101  * @param avrcp_browsing_cid
102  * @returns status
103  */
104 uint8_t avrcp_browsing_decline_incoming_connection(uint16_t avrcp_browsing_cid);
105 
106 /**
107  * @brief   Disconnect from AVRCP Browsing service
108  * @param   avrcp_browsing_cid
109  * @returns status
110  */
111 uint8_t avrcp_browsing_disconnect(uint16_t avrcp_browsing_cid);
112 
113 /* API_END */
114 
115 
116 #if defined __cplusplus
117 }
118 #endif
119 
120 #endif // AVRCP_BROWSING_H
121