1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2016-2018 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 #ifndef MICROPY_INCLUDED_DRIVERS_BUS_SPI_H
27 #define MICROPY_INCLUDED_DRIVERS_BUS_SPI_H
28 
29 #include "py/mphal.h"
30 
31 enum {
32     MP_SPI_IOCTL_INIT,
33     MP_SPI_IOCTL_DEINIT,
34 };
35 
36 typedef struct _mp_spi_proto_t {
37     int (*ioctl)(void *self, uint32_t cmd);
38     void (*transfer)(void *self, size_t len, const uint8_t *src, uint8_t *dest);
39 } mp_spi_proto_t;
40 
41 typedef struct _mp_soft_spi_obj_t {
42     uint32_t delay_half; // microsecond delay for half SCK period
43     uint8_t polarity;
44     uint8_t phase;
45     mp_hal_pin_obj_t sck;
46     mp_hal_pin_obj_t mosi;
47     mp_hal_pin_obj_t miso;
48 } mp_soft_spi_obj_t;
49 
50 extern const mp_spi_proto_t mp_soft_spi_proto;
51 
52 int mp_soft_spi_ioctl(void *self, uint32_t cmd);
53 void mp_soft_spi_transfer(void *self, size_t len, const uint8_t *src, uint8_t *dest);
54 
55 #endif // MICROPY_INCLUDED_DRIVERS_BUS_SPI_H
56