xref: /btstack/platform/embedded/hal_uart_dma.h (revision df25739fc3ea5a0a90f0f5925e6461d653697d2e)
1 /*
2  * Copyright (C) 2014 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  *  hal_uart_dma.h
40  *
41  *  Hardware abstraction layer that provides
42  *  - blockwise IRQ-driven read/write
43  *  - CSR IRQs
44  *
45  */
46 
47 #ifndef __HAL_UART_DMA_H
48 #define __HAL_UART_DMA_H
49 
50 #include <stdint.h>
51 
52 #if defined __cplusplus
53 extern "C" {
54 #endif
55 
56 void hal_uart_dma_init(void);
57 void hal_uart_dma_set_block_received( void (*block_handler)(void));
58 void hal_uart_dma_set_block_sent( void (*block_handler)(void));
59 void hal_uart_dma_set_csr_irq_handler( void (*csr_irq_handler)(void));
60 int  hal_uart_dma_set_baud(uint32_t baud);
61 void hal_uart_dma_send_block(const uint8_t *buffer, uint16_t length);
62 void hal_uart_dma_receive_block(uint8_t *buffer, uint16_t len);
63 void hal_uart_dma_set_sleep(uint8_t sleep);
64 
65 #if defined __cplusplus
66 }
67 #endif
68 #endif // __HAL_UART_DMA_H
69