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