1 /* 2 * This file is part of the MicroPython project, http://micropython.org/ 3 * 4 * The MIT License (MIT) 5 * 6 * Copyright (c) 2013, 2014 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_STM32_SPI_H 27 #define MICROPY_INCLUDED_STM32_SPI_H 28 29 #include "drivers/bus/spi.h" 30 #include "dma.h" 31 32 typedef struct _spi_t { 33 SPI_HandleTypeDef *spi; 34 const dma_descr_t *tx_dma_descr; 35 const dma_descr_t *rx_dma_descr; 36 } spi_t; 37 38 typedef struct _spi_proto_cfg_t { 39 const spi_t *spi; 40 uint32_t baudrate; 41 uint8_t polarity; 42 uint8_t phase; 43 uint8_t bits; 44 uint8_t firstbit; 45 } spi_proto_cfg_t; 46 47 typedef struct _pyb_spi_obj_t { 48 mp_obj_base_t base; 49 const spi_t *spi; 50 } pyb_spi_obj_t; 51 52 typedef struct _machine_hard_spi_obj_t { 53 mp_obj_base_t base; 54 const spi_t *spi; 55 } machine_hard_spi_obj_t; 56 57 extern SPI_HandleTypeDef SPIHandle1; 58 extern SPI_HandleTypeDef SPIHandle2; 59 extern SPI_HandleTypeDef SPIHandle3; 60 extern SPI_HandleTypeDef SPIHandle4; 61 extern SPI_HandleTypeDef SPIHandle5; 62 extern SPI_HandleTypeDef SPIHandle6; 63 64 extern const spi_t spi_obj[6]; 65 66 extern const mp_spi_proto_t spi_proto; 67 extern const mp_obj_type_t pyb_spi_type; 68 extern const mp_obj_type_t machine_hard_spi_type; 69 70 // A transfer of "len" bytes should take len*8*1000/baudrate milliseconds. 71 // To simplify the calculation we assume the baudrate is never less than 8kHz 72 // and use that value for the baudrate in the formula, plus a small constant. 73 #define SPI_TRANSFER_TIMEOUT(len) ((len) + 100) 74 75 void spi_init0(void); 76 void spi_init(const spi_t *spi, bool enable_nss_pin); 77 void spi_deinit(const spi_t *spi_obj); 78 int spi_find_index(mp_obj_t id); 79 void spi_set_params(const spi_t *spi_obj, uint32_t prescale, int32_t baudrate, 80 int32_t polarity, int32_t phase, int32_t bits, int32_t firstbit); 81 void spi_transfer(const spi_t *self, size_t len, const uint8_t *src, uint8_t *dest, uint32_t timeout); 82 void spi_print(const mp_print_t *print, const spi_t *spi_obj, bool legacy); 83 const spi_t *spi_from_mp_obj(mp_obj_t o); 84 85 #endif // MICROPY_INCLUDED_STM32_SPI_H 86