1 /* 2 * Copyright (c) 2017-2019, Texas Instruments Incorporated 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * * Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * * Neither the name of Texas Instruments Incorporated nor the names of 17 * its contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 27 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 28 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 /*!*************************************************************************** 33 * @file SDSPI.h 34 * 35 * @brief SD driver implementation built on the TI SPI driver. 36 * 37 * The SDSPI header file should be included in an application as follows: 38 * @code 39 * #include <ti/drivers/SD.h> 40 * #include <ti/drivers/sd/SDSPI.h> 41 * @endcode 42 * 43 * Refer to @ref SD.h for a complete description of APIs & example of use. 44 * 45 * This SD driver implementation can be used to communicate with SD cards 46 * via a SPI peripheral. This driver leverages the TI SPI driver to transfer 47 * data to/from the host processor to the SD card. The SD card chip select 48 * is also handled by this driver via the TI GPIO driver. Both the SPI 49 * driver instance & the GPIO pin (used as chip select) must be specified 50 * in the SDSPI hardware attributes. 51 * 52 * Note: This driver requires that the 'defaultTxBufValue' field in the SPI 53 * driver hardware attributes be set to '0xFF'. 54 * 55 * ## Data location & alignment # 56 * 57 * This driver relies on the TI SPI driver to configure the SPI peripheral & 58 * perform data transfers. This means that data to be transferred must comply 59 * with rules & restrictions set SPI driver (memory alignment & DMA 60 * accessibility requirements). Refer to @ref SPI.h & the device specific 61 * SPI implementation header files for details. 62 * 63 * <hr> 64 */ 65 66 #ifndef ti_drivers_sd_SDSPI__include 67 #define ti_drivers_sd_SDSPI__include 68 69 #include <stdint.h> 70 #include <ti/drivers/dpl/SemaphoreP.h> 71 #include <ti/drivers/SD.h> 72 #include <ti/drivers/SPI.h> 73 74 #ifdef __cplusplus 75 extern "C" { 76 #endif 77 78 /* SDSPI function table */ 79 extern const SD_FxnTable SDSPI_fxnTable; 80 81 /*! 82 * @brief SDSPI Hardware attributes 83 * 84 * The #SDSPI_HWAttrs configuration structure contains the index of the SPI 85 * peripheral to be used for data transfers & the index of the GPIO Pin which 86 * will act as chip select. This driver uses this information to: 87 * - configure & open the SPI driver instance for data transfers 88 * - select the SD card (via chip select) when performing data transfers 89 * 90 * @struct SDSPI_HWAttrs 91 * An example configuration structure could look as the following: 92 * @code 93 * const SDSPI_HWAttrs sdspiHWAttrs[1] = { 94 * { 95 * // SPI driver index 96 * .spiIndex = 0, 97 * 98 * // GPIO driver pin index 99 * .spiCsGpioIndex = 3 100 * } 101 * }; 102 * @endcode 103 */ 104 typedef struct { 105 uint_least8_t spiIndex; 106 uint16_t spiCsGpioIndex; 107 } SDSPI_HWAttrs; 108 109 /*! 110 * @brief SDSPI Object 111 * 112 * The application must not access any member variables of this structure! 113 */ 114 typedef struct { 115 SemaphoreP_Handle lockSem; 116 SPI_Handle spiHandle; 117 SD_CardType cardType; 118 bool isOpen; 119 } SDSPI_Object; 120 121 #ifdef __cplusplus 122 } 123 #endif 124 125 #endif /* ti_drivers_sd_SDSPI__include */ 126
