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