1 /* 2 * This file is part of the MicroPython project, http://micropython.org/ 3 * 4 * The MIT License (MIT) 5 * 6 * Copyright (c) 2016 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_EXTMOD_MACHINE_SPI_H 27 #define MICROPY_INCLUDED_EXTMOD_MACHINE_SPI_H 28 29 #include "py/obj.h" 30 #include "py/mphal.h" 31 #include "drivers/bus/spi.h" 32 33 // Temporary support for legacy construction of SoftSPI via SPI type. 34 #define MP_MACHINE_SPI_CHECK_FOR_LEGACY_SOFTSPI_CONSTRUCTION(n_args, n_kw, all_args) \ 35 do { \ 36 if (n_args == 0 || all_args[0] == MP_OBJ_NEW_SMALL_INT(-1)) { \ 37 mp_print_str(MICROPY_ERROR_PRINTER, "Warning: SPI(-1, ...) is deprecated, use SoftSPI(...) instead\n"); \ 38 if (n_args != 0) { \ 39 --n_args; \ 40 ++all_args; \ 41 } \ 42 return mp_machine_soft_spi_type.make_new(&mp_machine_soft_spi_type, n_args, n_kw, all_args); \ 43 } \ 44 } while (0) 45 46 // SPI protocol 47 typedef struct _mp_machine_spi_p_t { 48 void (*init)(mp_obj_base_t *obj, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args); 49 void (*deinit)(mp_obj_base_t *obj); // can be NULL 50 void (*transfer)(mp_obj_base_t *obj, size_t len, const uint8_t *src, uint8_t *dest); 51 } mp_machine_spi_p_t; 52 53 typedef struct _mp_machine_soft_spi_obj_t { 54 mp_obj_base_t base; 55 mp_soft_spi_obj_t spi; 56 } mp_machine_soft_spi_obj_t; 57 58 extern const mp_machine_spi_p_t mp_machine_soft_spi_p; 59 extern const mp_obj_type_t mp_machine_soft_spi_type; 60 extern const mp_obj_dict_t mp_machine_spi_locals_dict; 61 62 mp_obj_t mp_machine_spi_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args); 63 64 MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_machine_spi_read_obj); 65 MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_machine_spi_readinto_obj); 66 MP_DECLARE_CONST_FUN_OBJ_2(mp_machine_spi_write_obj); 67 MP_DECLARE_CONST_FUN_OBJ_3(mp_machine_spi_write_readinto_obj); 68 69 #endif // MICROPY_INCLUDED_EXTMOD_MACHINE_SPI_H 70