SD.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2019, 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.
 */

/*!***************************************************************************
 *  @file       SD.h
 *  @brief      Secure Digital (SD) Driver
 *
 *  @anchor ti_drivers_SD_Overview
 *  # Overview
 *
 *  The SD driver is designed to serve as an interface to perform basic
 *  transfers directly to the SD card.
 *
 *  <hr>
 *  @anchor ti_drivers_SD_Usage
 *  # Usage
 *  This section will cover driver usage.
 *
 *  @anchor ti_drivers_SD_Synopsis
 *  ## Synopsis
 *  @anchor ti_drivers_SD_Synopsis_Code
 *  @code
 *  SD_Handle handle;
 *  uint16_t status;
 *
 *  SD_init();
 *
 *  // Open SD and initialize card
 *  handle = SD_open(CONFIG_SD0, NULL);
 *  status = SD_initialize(handle);
 *  if (handle == NULL || status != SD_STATUS_SUCCESS) {
 *      //Error opening SD driver
 *      while (1);
 *  }
 *
 *  // Write and read back the first sector
 *  status = SD_write(handle, sendBuffer, 0, 1);
 *  if (status == SD_STATUS_SUCCESS) {
 *      status = SD_read(handle, readBuffer, 0 , 1);
 *  }
 *
 *  SD_close(handle);
 *  @endcode
 *
 *  @anchor ti_drivers_SD_Examples
 *  # Examples
 *  - @ref ti_drivers_SD_Synopsis "Overview"
 *  - @ref ti_drivers_SD_Example_getCardSpace "Get SD card size"
 *
 *  Get total capacity of an SD card:
 *  @anchor ti_drivers_SD_Example_getCardSpace
 *  @code
 *  SD_Handle handle;
 *  Display_Handle display;
 *  uint_fast32_t sectorSize, sectorCount;
 *
 *  // Init, open, etc
 *  ...
 *
 *  sectorSize = SD_getSectorSize(handle);
 *  sectorCount = SD_getNumSectors(handle);
 *
 *  Display_printf(display, 0, 0,"SD card total capacity is %lu bytes.",
 *                 sectorSize * sectorCount);
 *  @endcode
 *
 *  <hr>
 *  @anchor ti_drivers_SD_Configuration
 *  # Configuration
 *  Refer to the @ref driver_configuration "Driver's Configuration"
 *  section for driver configuration information.
 *
 *  <hr>
 ******************************************************************************
 */

#ifndef ti_drivers_SD__include
#define ti_drivers_SD__include

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SD_CMD_RESERVED    (32)

#define SD_STATUS_RESERVED    (-32)

#define SD_STATUS_SUCCESS    (0)

#define SD_STATUS_ERROR    (-1)

#define SD_STATUS_UNDEFINEDCMD    (-2)

/* Add SD_CMD_<commands> here */

typedef enum {
    SD_NOCARD = 0, 
    SD_MMC = 1,    
    SD_SDSC = 2,   
    SD_SDHC = 3    
} SD_CardType;

typedef struct SD_Config_ *SD_Handle;

/* SD Parameters */
typedef struct {
    void   *custom;  
} SD_Params;

typedef void (*SD_CloseFxn) (SD_Handle handle);

typedef int_fast16_t (*SD_ControlFxn) (SD_Handle handle,
    uint_fast16_t cmd, void *arg);

typedef uint_fast32_t (*SD_getNumSectorsFxn) (SD_Handle handle);

typedef uint_fast32_t (*SD_getSectorSizeFxn) (SD_Handle handle);

typedef void (*SD_InitFxn) (SD_Handle handle);

typedef int_fast16_t (*SD_InitializeFxn) (SD_Handle handle);

typedef SD_Handle (*SD_OpenFxn) (SD_Handle handle, SD_Params *params);

typedef int_fast16_t (*SD_ReadFxn) (SD_Handle handle, void *buf,
    int_fast32_t sector, uint_fast32_t secCount);

typedef int_fast16_t (*SD_WriteFxn) (SD_Handle handle, const void *buf,
    int_fast32_t sector, uint_fast32_t secCount);

typedef struct {
    SD_CloseFxn             closeFxn;
    SD_ControlFxn           controlFxn;
    SD_getNumSectorsFxn     getNumSectorsFxn;
    SD_getSectorSizeFxn     getSectorSizeFxn;
    SD_InitFxn              initFxn;
    SD_InitializeFxn        initializeFxn;
    SD_OpenFxn              openFxn;
    SD_ReadFxn              readFxn;
    SD_WriteFxn             writeFxn;
} SD_FxnTable;

typedef struct SD_Config_ {
    SD_FxnTable const    *fxnTablePtr;

    void                 *object;

    void const           *hwAttrs;
} SD_Config;

extern void SD_close(SD_Handle handle);

extern int_fast16_t SD_control(SD_Handle handle, uint_fast16_t cmd, void *arg);

extern uint_fast32_t SD_getNumSectors(SD_Handle handle);

extern uint_fast32_t SD_getSectorSize(SD_Handle handle);

extern void SD_init(void);

extern void SD_Params_init(SD_Params *params);

extern int_fast16_t SD_initialize(SD_Handle handle);

extern SD_Handle SD_open(uint_least8_t index, SD_Params *params);

extern int_fast16_t SD_read(SD_Handle handle, void *buf,
    int_fast32_t sector, uint_fast32_t secCount);

extern int_fast16_t SD_write(SD_Handle handle, const void *buf,
    int_fast32_t sector, uint_fast32_t secCount);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_SD__include */