xref: /btstack/src/btstack_uart_block.h (revision b52fe0206e86ee983c386482e49cab6239b8dba0)
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  *  btstack_uart_block.h
40  *
41  *  Common code to access serial port via asynchronous block read/write commands
42  *
43  */
44 
45 #ifndef __BTSTACK_UART_BLOCK_H
46 #define __BTSTACK_UART_BLOCK_H
47 
48 #include <stdint.h>
49 #include "hci_transport.h"
50 
51 typedef struct {
52     /**
53      * init transport
54      * @param transport_config
55      */
56     int (*init)(const hci_transport_config_uart_t * config);
57 
58     /**
59      * open transport connection
60      */
61     int (*open)(void);
62 
63     /**
64      * close transport connection
65      */
66     int (*close)(void);
67 
68     /**
69      * set callback for block received
70      */
71     void (*set_block_received)(void (*block_handler)(void));
72 
73     /**
74      * set callback for sent
75      */
76     void (*set_block_sent)(void (*block_handler)(void));
77 
78     /**
79      * set baudrate
80      */
81     int (*set_baudrate)(uint32_t baudrate);
82 
83     /**
84      * set parity
85      */
86     int  (*set_parity)(int parity);
87 
88     /**
89      * receive block
90      */
91     void (*receive_block)(uint8_t *buffer, uint16_t len);
92 
93     /**
94      * send block
95      */
96     void (*send_block)(const uint8_t *buffer, uint16_t length);
97 
98     // void hal_uart_dma_set_sleep(uint8_t sleep);
99     // void hal_uart_dma_set_csr_irq_handler( void (*csr_irq_handler)(void));
100 
101 } btstack_uart_block_t;
102 
103 // common implementations
104 const btstack_uart_block_t * btstack_uart_block_posix_instance(void);
105 
106 #endif
107