iot_i2s.h

/*
 * 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
 */
 
/*******************************************************************************
 * @file iot_hal_i2s.h
 * @brief File for the APIs of I2S called by application layer.
 *******************************************************************************
 */
 
#ifndef _IOT_I2S_H_
#define _IOT_I2S_H_
 
#define IOT_I2S_SUCCESS                   ( 0 )  
#define IOT_I2S_INVALID_VALUE             ( 1 )  
#define IOT_I2S_NOT_INITIALIZED           ( 2 )  
#define IOT_I2S_BUSY                      ( 3 )  
#define IOT_I2S_WRITE_FAILED              ( 4 )  
#define IOT_I2S_READ_FAILED               ( 5 )  
#define IOT_I2S_NOTHING_TO_CANCEL         ( 7 )  
#define IOT_I2S_FUNCTION_NOT_SUPPORTED    ( 8 )  
typedef enum
{
    eI2SBusIdle = 0,            
    eI2SBusBusy = IOT_I2S_BUSY, 
} IotI2SBusStatus_t;
 
typedef enum
{
    eI2SCompleted = IOT_I2S_SUCCESS,            
    eI2SLastWriteFailed = IOT_I2S_WRITE_FAILED, 
    eI2SLastReadFailed = IOT_I2S_READ_FAILED,   
} IotI2SOperationStatus_t;
 
typedef enum
{
    eI2SSetConfig,      
    eI2SGetConfig,      
    eI2SGetBusState,    
    eI2SGetTxNoOfbytes, 
    eI2SGetRxNoOfbytes, 
} IotI2SIoctlRequest_t;
 
typedef enum
{
    eI2SNormalMode,         
    eI2SLeftJustifiedMode,  
    eI2SRightJustifiedMode, 
    eI2SPcmMode,            
    eI2SDspMode,            
} IotI2SMode_t;
 
typedef enum
{
    eI2SChannelStereo, 
    eI2SChannelMono,   
} IotI2SChannel_t;
 
typedef enum
{
    eI2SFallingEdge, 
    eI2SRisingEdge,  
} IotI2SClkPolarity_t;
 
typedef struct
{
    IotI2SMode_t xI2SMode;               
    IotI2SChannel_t xI2SChannel;         
    IotI2SClkPolarity_t xI2SSckPolarity; 
    IotI2SClkPolarity_t xI2SWsPolarity;  
    uint32_t ulI2SFrequency;             
    uint32_t ulI2SDataLength;            
    uint32_t ulI2SFrameLength;           
} IotI2sIoctlConfig_t;
 
struct IotI2SDescriptor;
 
typedef struct IotI2SDescriptor * IotI2SHandle_t;
 
typedef void ( * IotI2SCallback_t )( IotI2SOperationStatus_t xOpStatus,
                                     void * pvUserContext );
 
IotI2SHandle_t iot_i2s_open( int32_t lI2SInstance );
 
void iot_i2s_set_callback( IotI2SHandle_t const pxI2SPeripheral,
                           IotI2SCallback_t xCallback,
                           void * pvUserContext );
 
int32_t iot_i2s_read_async( IotI2SHandle_t const pxI2SPeripheral,
                            uint8_t * const pvBuffer,
                            size_t xBytes );
 
int32_t iot_i2s_write_async( IotI2SHandle_t const pxI2SPeripheral,
                             uint8_t * const pvBuffer,
                             size_t xBytes );
 
int32_t iot_i2s_read_sync( IotI2SHandle_t const pxI2SPeripheral,
                           uint8_t * const pvBuffer,
                           size_t xBytes );
 
int32_t iot_i2s_write_sync( IotI2SHandle_t const pxI2SPeripheral,
                            uint8_t * const pvBuffer,
                            size_t xBytes );
 
int32_t iot_i2s_close( IotI2SHandle_t const pxI2SPeripheral );
 
int32_t iot_i2s_ioctl( IotI2SHandle_t const pxI2SPeripheral,
                       IotI2SIoctlRequest_t xI2SRequest,
                       void * const pvBuffer );
 
int32_t iot_i2s_cancel( IotI2SHandle_t const pxI2SPeripheral );
 
#endif /* ifndef _IOT_HAL_I2S_H_ */