SDSPICC32XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_sdspi_SDSPICC32XX__include
#define ti_drivers_sdspi_SDSPICC32XX__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <ti/drivers/SDSPI.h>
#include <ti/drivers/Power.h>

#include <third_party/fatfs/ff.h>
#include <third_party/fatfs/diskio.h>

#define SDSPICC32XX_GPIO0  (0x00 << 16)
#define SDSPICC32XX_GPIO1  (0x01 << 16)
#define SDSPICC32XX_GPIO2  (0x02 << 16)
#define SDSPICC32XX_GPIO3  (0x03 << 16)
#define SDSPICC32XX_GPIO4  (0x04 << 16)
#define SDSPICC32XX_GPIO5  (0x05 << 16)
#define SDSPICC32XX_GPIO6  (0x06 << 16)
#define SDSPICC32XX_GPIO7  (0x07 << 16)
#define SDSPICC32XX_GPIO8  (0x10 << 16)
#define SDSPICC32XX_GPIO9  (0x11 << 16)
#define SDSPICC32XX_GPIO10  (0x12 << 16)
#define SDSPICC32XX_GPIO11  (0x13 << 16)
#define SDSPICC32XX_GPIO12  (0x14 << 16)
#define SDSPICC32XX_GPIO13  (0x15 << 16)
#define SDSPICC32XX_GPIO14  (0x16 << 16)
#define SDSPICC32XX_GPIO15  (0x17 << 16)
#define SDSPICC32XX_GPIO16  (0x20 << 16)
#define SDSPICC32XX_GPIO17  (0x21 << 16)
#define SDSPICC32XX_GPIO18  (0x22 << 16)
#define SDSPICC32XX_GPIO19  (0x23 << 16)
#define SDSPICC32XX_GPIO20  (0x24 << 16)
#define SDSPICC32XX_GPIO21  (0x25 << 16)
#define SDSPICC32XX_GPIO22  (0x26 << 16)
#define SDSPICC32XX_GPIO23  (0x27 << 16)
#define SDSPICC32XX_GPIO24  (0x30 << 16)
#define SDSPICC32XX_GPIO25  (0x31 << 16)
#define SDSPICC32XX_GPIO26  (0x32 << 16)
#define SDSPICC32XX_GPIO27  (0x33 << 16)
#define SDSPICC32XX_GPIO28  (0x34 << 16)
#define SDSPICC32XX_GPIO29  (0x35 << 16)
#define SDSPICC32XX_GPIO30  (0x36 << 16)
#define SDSPICC32XX_GPIO31  (0x37 << 16)

#define SDSPICC32XX_GPIONONE  (0xFF << 16)

/*
 * We need to encode a pin's GPIO function along with the SPI function,
 * since certain SPI functions need to be handled via manual programming
 * of a GPIO pin.
 *
 * PIN_62 is special for the SDSPI driver when using an SD Boosterpack,
 * as PIN_62 doesn't have an assigned SPI function yet the SD Boosterpack
 * has it tied to the CS signal.
 */
#define SDSPICC32XX_PIN_05_CLK    0x0704
#define SDSPICC32XX_PIN_06_MISO   0x0705
#define SDSPICC32XX_PIN_07_MOSI   0x0706
#define SDSPICC32XX_PIN_08_CS    (SDSPICC32XX_GPIO17 | 0x0707)
#define SDSPICC32XX_PIN_62_GPIO  (SDSPICC32XX_GPIO7  | 0x003d)
#define SDSPICC32XX_PIN_45_CLK    0x072c
#define SDSPICC32XX_PIN_50_CS    (SDSPICC32XX_GPIO0  | 0x0931)
#define SDSPICC32XX_PIN_52_MOSI   0x0833
#define SDSPICC32XX_PIN_53_MISO   0x0734

/* Add SDSPICC32XX_STATUS_* macros here */

/* Add SDSPICC32XX_CMD_* macros here */

typedef unsigned long SDSPIBaseAddrType;
typedef unsigned long SDSPIDataType;

/* SDSPI function table */
extern const SDSPI_FxnTable SDSPICC32XX_fxnTable;

typedef enum SDSPICC32XX_CardType {
    SDSPICC32XX_NOCARD = 0, 
    SDSPICC32XX_MMC = 1,    
    SDSPICC32XX_SDSC = 2,   
    SDSPICC32XX_SDHC = 3    
} SDSPICC32XX_CardType;

typedef struct SDSPICC32XX_HWAttrsV1 {
    uint32_t baseAddr;
    uint32_t spiPRCM;
    uint32_t clkPin;
    uint32_t mosiPin;
    uint32_t misoPin;
    uint32_t csPin;
} SDSPICC32XX_HWAttrsV1;

typedef struct SDSPICC32XX_Object {
    uint32_t              driveNumber;   /* Drive number used by FatFs */
    DSTATUS               diskState;     /* Disk status */
    SDSPICC32XX_CardType  cardType;      /* SDCard Card Command Class (CCC) */
    uint32_t              bitRate;       /* SPI bus bit rate (Hz) */
    FATFS                 filesystem;    /* FATFS data object */
    uint_fast16_t         spiPowerMgrId;    /* Determined from base address */
    uint_fast16_t         gpioCsPowerMgrId; /* Determined from base address */
    Power_NotifyObj       postNotify;    /* LPDS wake-up notify object */
} SDSPICC32XX_Object, *SDSPICC32XX_Handle;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_sdspi_SDSPICC32XX__include */