iot_sdio.h

Go to the documentation of this file.

/*
 * Common IO - basic V1.0.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
 
#ifndef _IOT_SDIO_H_
#define _IOT_SDIO_H_
 
#include <stdint.h>
#include <stdbool.h>
 
 
#define IOT_SDIO_SUCCESS                       ( 0 )
 
#define IOT_SDIO_IOCTL_FAIL                    ( 1 )
 
#define IOT_SDIO_HOST_INIT_FAIL                ( 2 )
 
#define IOT_SDIO_INVALID_VALUE                 ( 3 )
 
#define IOT_SDIO_TRANSFER_FAIL                 ( 4 )
 
#define IOT_SDIO_SWITCH_HIGH_SPEED_FAIL        ( 5 )
 
#define IOT_SDIO_LOW_SPEED_CARD                ( 6 )
 
#define IOT_SDIO_SELECT_BUS_TIMING_FAIL        ( 7 )
 
#define IOT_SDIO_SET_CARD_BLOCK_SIZE_FAIL      ( 8 )
 
#define IOT_SDIO_SWITCH_VOLTAGE_FAIL           ( 9 )
 
#define IOT_SDIO_HOST_NOT_READY                ( 10 )
 
#define IOT_SDIO_INVALID_CARD                  ( 11 )
 
#define IOT_SDIO_SEND_RELATIVE_ADDRESS_FAIL    ( 12 )
 
#define IOT_SDIO_SELECT_CARD_FAIL              ( 13 )
 
#define IOT_SDIO_READ_CIS_FAIL                 ( 14 )
 
#define IOT_SDIO_SET_DATA_BUS_WIDTH_FAIL       ( 15 )
 
#define IOT_SDIO_ASYNC_INT_NOT_SUPPORTED       ( 16 )
 
#define IOT_SDIO_GET_CARD_CAPABILITY_FAIL      ( 17 )
 
#define IOT_SDIO_FUNCTION_NOT_SUPPORTED        ( 18 )
 
#define IOT_SDIO_BUS_1BIT    ( 0 )
/* 1 is reserved per SDIO specification */
#define IOT_SDIO_BUS_4BIT    ( 2 )
#define IOT_SDIO_BUS_8BIT    ( 3 )
 
typedef enum IotSdioDirection
{
    eIORead = 0U,  
    eIOWrite = 1U, 
} IotSdioDirection_t;
 
typedef enum IotSdioFunction
{
    eSdioFunction0,      
    eSdioFunction1,      
    eSdioFunction2,      
    eSdioFunction3,      
    eSdioFunction4,      
    eSdioFunction5,      
    eSdioFunction6,      
    eSdioFunction7,      
    eSdioFunctionMemory, 
} IotSdioFunction_t;
 
typedef enum IotSdioCardDetectType
{
    eDetectCardByGpioCD,    
    eDetectCardByHostCD,    
    eDetectCardByHostDATA3, 
    eDetectCardNonStandard, 
} IotSdioCardDetectType_t;
 
typedef enum IotSdioEventType
{
    eSdioCardInterruptEvent, 
    eSdioCardInsertedEvent,  
    eSdioCardRemovedEvent,   
    eSdioCardPowerOnEvent,   
    eSdioCardPowerOffEvent,  
} IotSdioEventType_t;
 
typedef enum IotSdioIoctlRequest
{
    eSDIOSetDriverStrength,   
    eSDIOSetCardInactive,     
    eSDIOSwitchToHighSpeed,   
    eSDIOSetDataBusWidth,     
    eSDIOGetCardCapabilities, 
    eSDIOSetCardDetectParams, 
    eSDIOSetFuncBlockSize,    
    eSDIOEnableIOFunctionIrq, 
    eSDIOEnableAsyncIrqMode,  
    eSDIOEnableIo,            
    eSDIOSelectIo,            
    eSDIOAbortIo,             
    eSDIOReadCis,             
    eSDIOPowerOnOffCard,      
    eSDIOCheckCardPresence,   
} IotSdioIoctlRequest_t;
 
typedef enum IotSdioBusWidth
{
    eDataBus1Bit = IOT_SDIO_BUS_1BIT, 
    eDataBus4Bit = IOT_SDIO_BUS_4BIT, 
    eDataBus8Bit = IOT_SDIO_BUS_8BIT, 
} IotSdioBusWidth_t;
 
typedef struct IoTSdioCardDetectParam
{
    IotSdioCardDetectType_t eCardDetectType; 
    bool bCallbackOnInsert;                  
    bool bCallbackOnRemoval;                 
} IotSdioCardDetectParam_t;
 
typedef struct IoTSdioPowerOnOffCard
{
    bool bPowerOn;     
    bool bUseCallback; 
} IoTSdioPowerOnOffCard_t;
 
typedef struct IotSdioFuncBlkSize
{
    IotSdioFunction_t eFunc; 
    uint32_t ulBlockSize;    
} IotSdioFuncBlkSize_t;
 
typedef struct IotSdioPerFuncEnable
{
    IotSdioFunction_t eFunc; 
    bool bEnable;            
} IotSdioPerFuncEnable_t;
 
typedef struct IotSdioReadCis
{
    IotSdioFunction_t eFunc;       
    const uint32_t * pulTupleList; 
    uint32_t ulTupleNum;           
} IotSdioReadCis_t;
 
typedef enum IotSdioSdDriverStrength
{
    eSdDriverStrengthTypeB = 0U, 
    eSdDriverStrengthTypeA = 1U, 
    eSdDriverStrengthTypeC = 2U, 
    eSdDriverStrengthTypeD = 3U, 
} IotSdioSdDriverStrength_t;
 
struct IotSdioSlotDescriptor;
 
typedef struct IotSdioSlotDescriptor * IotSdioSlotHandle_t;
 
typedef void (* IotSdioCallback_t) ( IotSdioSlotHandle_t const pxSdioHandle,
                                     IotSdioEventType_t eSdioEvent,
                                     void * pvUserContext );
 
typedef void (* IotSdioIOFunctionCallback_t) ( IotSdioSlotHandle_t const pxSdioHandle,
                                               IotSdioFunction_t eFunc,
                                               void * pvUserContext );
 
IotSdioSlotHandle_t iot_sdio_open( uint8_t ucHostIdx,
                                   uint8_t ucSlotIdx );
 
int32_t iot_sdio_close( IotSdioSlotHandle_t const pxSdioHandle );
 
int32_t iot_sdio_card_connect( IotSdioSlotHandle_t const pxSdioHandle );
 
int32_t iot_sdio_card_disconnect( IotSdioSlotHandle_t const pxSdioHandle );
 
int32_t iot_sdio_card_reset( IotSdioSlotHandle_t const pxSdioHandle );
 
int32_t iot_sdio_io_write_direct( IotSdioSlotHandle_t const pxSdioHandle,
                                  IotSdioFunction_t eFunc,
                                  uint32_t ulRegAddr,
                                  uint8_t * pucData,
                                  bool bRaw );
 
int32_t iot_sdio_io_read_direct( IotSdioSlotHandle_t const pxSdioHandle,
                                 IotSdioFunction_t eFunc,
                                 uint32_t ulRegAddr,
                                 uint8_t * pucData );
 
int32_t iot_sdio_io_write_extended( IotSdioSlotHandle_t const pxSdioHandle,
                                    IotSdioFunction_t eFunc,
                                    bool bBlockMode,
                                    bool bOpcode,
                                    uint32_t ulRegAddr,
                                    uint8_t * pucBuf,
                                    uint32_t ulCount );
 
int32_t iot_sdio_io_read_extended( IotSdioSlotHandle_t const pxSdioHandle,
                                   IotSdioFunction_t eFunc,
                                   bool bBlockMode,
                                   bool bOpcode,
                                   uint32_t ulRegAddr,
                                   uint8_t * pucBuf,
                                   uint32_t ulCount );
 
int32_t iot_sdio_set_io_function_callback( IotSdioSlotHandle_t const pxSdioHandle,
                                           IotSdioFunction_t eFunc,
                                           IotSdioIOFunctionCallback_t xIOFunctionCallback,
                                           void * pvIOFunctionCallbackUserContext );
 
int32_t iot_sdio_set_sdio_callback( IotSdioSlotHandle_t const pxSdioHandle,
                                    IotSdioCallback_t xSdioCallback,
                                    void * pvSdioCallbackUserContext );
 
int32_t iot_sdio_ioctl( IotSdioSlotHandle_t const pxSdioHandle,
                        IotSdioIoctlRequest_t xSdioIoctlRequest,
                        void * const pvBuffer );
 
#endif /* _IOT_SDIO_H_ */