1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2019 Damien P. George
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 
27 #ifndef MICROPY_INCLUDED_EXTMOD_MPBTHCI_H
28 #define MICROPY_INCLUDED_EXTMOD_MPBTHCI_H
29 
30 // --- Optionally can be implemented by the driver. ---------------------------
31 
32 // Start/stop the HCI controller.
33 // Requires the UART to this HCI controller is available.
34 int mp_bluetooth_hci_controller_init(void);
35 int mp_bluetooth_hci_controller_deinit(void);
36 
37 // Tell the controller to go to sleep (e.g. on RX if we don't think we're expecting anything more).
38 int mp_bluetooth_hci_controller_sleep_maybe(void);
39 // True if the controller woke us up.
40 bool mp_bluetooth_hci_controller_woken(void);
41 // Wake up the controller (e.g. we're about to TX).
42 int mp_bluetooth_hci_controller_wakeup(void);
43 
44 // --- Bindings that need to be implemented by the port. ----------------------
45 int mp_bluetooth_hci_uart_init(uint32_t port, uint32_t baudrate);
46 int mp_bluetooth_hci_uart_deinit(void);
47 int mp_bluetooth_hci_uart_set_baudrate(uint32_t baudrate);
48 int mp_bluetooth_hci_uart_readchar(void);
49 int mp_bluetooth_hci_uart_write(const uint8_t *buf, size_t len);
50 
51 #endif // MICROPY_INCLUDED_EXTMOD_MPBTHCI_H
52