xref: /btstack/src/btstack_sco_transport.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2021 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 SCO Transport
40  *
41  * Hardware abstraction for PCM/I2S Inteface used for HSP/HFP profiles.
42  *
43  */
44 
45 #ifndef BTSTACK_SCO_TRANSPORT_H
46 #define BTSTACK_SCO_TRANSPORT_H
47 
48 #include "btstack_config.h"
49 
50 #include "bluetooth.h"
51 #include "btstack_defines.h"
52 
53 #include <stdint.h>
54 
55 #if defined __cplusplus
56 extern "C" {
57 #endif
58 
59 typedef enum {
60     SCO_FORMAT_8_BIT,
61     SCO_FORMAT_16_BIT,
62 } sco_format_t;
63 
64 /* API_START */
65 
66 typedef struct {
67 
68     /**
69      * register packet handler for SCO HCI packets
70      */
71     void (*register_packet_handler)(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size));
72 
73     /**
74      * open transport
75      * @param con_handle of SCO connection
76      * @param sco_format
77      */
78     void (*open)(hci_con_handle_t con_handle, sco_format_t sco_format);
79 
80     /**
81      * send SCO packet
82      */
83     void (*send_packet)(const uint8_t *buffer, uint16_t length);
84 
85     /**
86      * close transport
87      * @param con_handle of SCO connection
88      */
89     void (*close)(hci_con_handle_t con_handle);
90 
91 } btstack_sco_transport_t;
92 
93 /* API_END */
94 
95 #if defined __cplusplus
96 }
97 #endif
98 
99 #endif