MMCSD.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014-2015 Texas Instruments Incorporated - http://www.ti.com/
 *
 * 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 MMCSD_H
#define MMCSD_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stddef.h>

#define MMCSD_OK                                 (0)

#define MMCSD_CMD_RESERVED                           (32U)

#define MMCSD_ERR                                   (-(1))

#define MMCSD_UNDEFINEDCMD                          (-(2))


#define MMCSD_ERR_1P8V_SWITCH_CARD_NOT_RESPONDING   (-(3))

#define MMCSD_ERR_1P8V_SWITCH_MMCIO_SWITCH_FAILURE  (-(4))

#define MMCSD_ERR_1P8V_SWITCH_CARD_CMD11_FAILURE    (-(5))

#define MMCSD_ERR_INVALID_FREQ                       (-(6))

#define MMCSD_ERR_FREQ_SWITCH_UNSUCCESSFUL           (-(7))

#define MMCSD_ERR_VOLTAGE_SWITCH_FAILURE             (-(8))

#define MMCSD_ERR_SET_SOC_INTERRUPT_PATH             (-(9))

#define MMCSD_ERR_REL_SOC_INTERRUPT_PATH             (-(10))

#define MMCSD_ERR_TUNING_CMD_ERROR             (-(11))

typedef int32_t                MMCSD_Error;

typedef void                  *MMCSD_Handle;

typedef void                  *MMCSD_Params;

typedef void (*MMCSD_CardDetectCallbackFxn)(MMCSD_Handle handle, uint32_t temp);

typedef struct MMCSD_ConfigParams_s {
    void             *custom;     
    MMCSD_CardDetectCallbackFxn cardDetectCallback; 
} MMCSD_ConfigParams;

typedef MMCSD_Error (*MMCSD_CloseFxn)    (MMCSD_Handle handle);

typedef MMCSD_Error (*MMCSD_ControlFxn)  (MMCSD_Handle handle,
                                          uint32_t cmd,
                                          const void *arg);

typedef MMCSD_Error (*MMCSD_InitFxn)     (MMCSD_Handle handle);

typedef MMCSD_Error (*MMCSD_OpenFxn) (MMCSD_Handle handle,
                                      MMCSD_Params params);

typedef MMCSD_Error (*MMCSD_WriteFxn) (MMCSD_Handle handle,
                                       uint8_t *buf,
                                       uint32_t block,
                                       uint32_t numBlks);

typedef MMCSD_Error (*MMCSD_ReadFxn) (MMCSD_Handle handle,
                                      uint8_t *buf,
                                      uint32_t block,
                                      uint32_t numBlks);

typedef struct MMCSD_FxnTable_s {
    MMCSD_CloseFxn             closeFxn;

    MMCSD_ControlFxn           controlFxn;

    MMCSD_InitFxn              initFxn;

    MMCSD_OpenFxn              openFxn;

    MMCSD_WriteFxn             writeFxn;

    MMCSD_ReadFxn              readFxn;
} MMCSD_FxnTable;

/* SD function table pointer */
extern const MMCSD_FxnTable MMCSD_fxnTable;

typedef struct MMCSD_Config_s {
    MMCSD_FxnTable const *fxnTablePtr;

    void                 *object;

    void           const *hwAttrs;
} MMCSD_Config;

typedef struct MMCSD_mediaParams_s {
    uint32_t blockSize;
    
    uint64_t blockCount;

    uint64_t size;

} MMCSD_mediaParams;


#define MMCSD_MAX_CONFIG_CNT       (5U) 
typedef MMCSD_Config MMCSD_Config_list[MMCSD_MAX_CONFIG_CNT];

extern const MMCSD_Config_list MMCSD_config;

extern MMCSD_Error MMCSD_close(MMCSD_Handle handle);

extern MMCSD_Error MMCSD_control(MMCSD_Handle handle, uint32_t cmd, void *arg);

extern MMCSD_Error MMCSD_init(void);

extern MMCSD_Error MMCSD_open(uint32_t index,
                              MMCSD_Params params,
                              MMCSD_Handle *handle);

extern MMCSD_Error MMCSD_Params_init(MMCSD_Params params);

extern MMCSD_Error MMCSD_write(MMCSD_Handle handle,
                               uint8_t *buf,
                               uint32_t block,
                               uint32_t numBlks);

extern MMCSD_Error MMCSD_read(MMCSD_Handle handle,
                              uint8_t *buf,
                              uint32_t block,
                              uint32_t numBlks);

#ifdef __cplusplus
}
#endif

#endif /* _MMCSD_H_ */
/* @} */