SDHostCC3200.h

Go to the documentation of this file.

/*
 * Copyright (c) 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_sdhost_SDHostCC3200__include
#define ti_drivers_sdhost_SDHostCC3200__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <ti/drivers/ports/HwiP.h>
#include <ti/drivers/ports/SemaphoreP.h>
#include <ti/drivers/Power.h>
#include <ti/mw/fatfs/ff.h>
#include <ti/mw/fatfs/diskio.h>

#define SDHostCC3200_CMD_RESERVED                (32)

#define SDHostCC3200_STATUS_RESERVED             (-32)

#define SDHostCC3200_STATUS_SUCCESS              (0)

#define SDHostCC3200_STATUS_ERROR                (-1)

#define SDHostCC3200_STATUS_UNDEFINEDCMD         (-2)

/* Add SDHostCC3200_CMD_<commands> here */

typedef enum SDHostCC3200_CardType {
    SDHostCC3200_NOCARD = 0, 
    SDHostCC3200_MMC = 1,    
    SDHostCC3200_SDSC = 2,   
    SDHostCC3200_SDHC = 3    
} SDHostCC3200_CardType;

typedef struct SDHostCC3200_HWAttrs {
    uint_fast32_t clkRate;

    int_fast32_t intPriority;

    uint_fast32_t baseAddr;

    int_least8_t dataPin;

    int_least8_t dataPinMode;

    int_least8_t cmdPin;

    int_least8_t cmdPinMode;

    int_least8_t clkPin;

    int_least8_t clkPinMode;
} SDHostCC3200_HWAttrs;

typedef struct SDHostCC3200_Object {
    /* Disk status */
    DSTATUS                    diskState;
    /* FATFS data object */
    FATFS                      filesystem;
    /* Drive number (1 Supported) */
    uint_fast32_t              driveNumber;
    /* Number of sectors on the device */
    uint_fast32_t              numSec;
    /* Relative Card Address */
    uint_fast32_t              rca;
    /* SD Card command state */
    volatile int_fast32_t      stat;
    /* SDCard Card Command Class(CCC) */
    SDHostCC3200_CardType      cardType;
    SemaphoreP_Handle          sdSem;
    HwiP_Handle                hwiHandle;
    /* LPDS wake-up notify object */
    Power_NotifyObj            postNotify;
    /* Determined from base address */
    unsigned int               powerMgrId;
} SDHostCC3200_Object;

typedef struct SDHostCC3200_Config      *SDHostCC3200_Handle;

typedef struct SDHostCC3200_Config {
    void             *object;

    void const       *hwAttrs;
} SDHostCC3200_Config;

 /* SDHostCC3200 functions */
typedef struct SDHostCC3200_Params {
    uintptr_t custom;  
} SDHostCC3200_Params;

void SDHostCC3200_Params_init(SDHostCC3200_Params *params);

void SDHostCC3200_close(SDHostCC3200_Handle handle);

void SDHostCC3200_init(SDHostCC3200_Handle handle);

int_fast8_t SDHostCC3200_control(SDHostCC3200_Handle handle, uint_fast32_t cmd,
    uintptr_t arg);

SDHostCC3200_Handle SDHostCC3200_open(uint_least8_t index, uint_least8_t drv,
    SDHostCC3200_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_sdhost_SDHostCC3200__include */