I2S.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, 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_I2S__include
#define ti_drivers_I2S__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/drivers/utils/List.h>

#define I2S_CMD_RESERVED            32

#define I2S_STATUS_RESERVED        -32

#define I2S_STATUS_SUCCESS         0

#define I2S_STATUS_ERROR          -1

#define I2S_STATUS_UNDEFINEDCMD   -2

/* Add I2S_CMD_<commands> here */

#define I2S_ERROR  I2S_STATUS_ERROR

#define I2S_WAIT_FOREVER ~(0)

typedef struct I2S_Config      *I2S_Handle;

typedef struct I2S_BufDesc {

    List_Elem              qElem;

    void                   *bufPtr;

    size_t                 bufSize;

    uintptr_t              arg;
} I2S_BufDesc;

typedef void        (*I2S_Callback)    (I2S_Handle, I2S_BufDesc *desc);

typedef enum I2S_DataMode {
    I2S_MODE_CALLBACK,

    I2S_MODE_ISSUERECLAIM
} I2S_DataMode;

typedef enum I2S_OpMode {
    I2S_OPMODE_TX_ONLY,       
    I2S_OPMODE_RX_ONLY,       
    I2S_OPMODE_TX_RX_SYNC     
} I2S_OpMode;

typedef enum I2S_SerInActiveConfig {
    I2S_SERCONFIG_INACT_TRI_STATE,  
    I2S_SERCONFIG_INACT_LOW_LEVEL,  
    I2S_SERCONFIG_INACT_HIGH_LEVEL  
} I2S_SerInActiveConfig;

typedef enum I2S_PinMode {
    I2S_PINMODE_RX,                 
    I2S_PINMODE_TX,                 
    I2S_PINMODE_INACTIVE            
} I2S_PinMode;

typedef struct I2S_Params {
    I2S_OpMode            operationMode;

    uint32_t              samplingFrequency;

    unsigned char         slotLength;

    unsigned char         bitsPerSample;

    unsigned char         numChannels;

    I2S_DataMode          readMode;

    I2S_Callback          readCallback;

    uint32_t              readTimeout;

    I2S_DataMode          writeMode;

    I2S_Callback          writeCallback;

    uint32_t              writeTimeout;

    uintptr_t            customParams;
} I2S_Params;

typedef void        (*I2S_CloseFxn)          (I2S_Handle handle);

typedef int         (*I2S_ControlFxn)        (I2S_Handle handle,
                                              unsigned int cmd,
                                              void *arg);

typedef void        (*I2S_InitFxn)           (I2S_Handle handle);

typedef I2S_Handle  (*I2S_OpenFxn)           (I2S_Handle handle,
                                              I2S_Params *params);

typedef int        (*I2S_IssueFxn)      (I2S_Handle handle,I2S_BufDesc *desc);

typedef size_t    (*I2S_ReclaimFxn)    (I2S_Handle handle,I2S_BufDesc **desc);

typedef struct I2S_FxnTable {
    I2S_CloseFxn           closeFxn;

    I2S_ControlFxn         controlFxn;

    I2S_InitFxn            initFxn;

    I2S_OpenFxn            openFxn;

    I2S_IssueFxn           readIssueFxn;

    I2S_ReclaimFxn         readReclaimFxn;

    I2S_IssueFxn           writeIssueFxn;

    I2S_ReclaimFxn         writeReclaimFxn;

} I2S_FxnTable;

typedef struct I2S_Config {
    I2S_FxnTable const    *fxnTablePtr;

    void                   *object;

    void          const    *hwAttrs;
} I2S_Config;

extern void I2S_close(I2S_Handle handle);

extern int I2S_control(I2S_Handle handle, unsigned int cmd, void *arg);

extern void I2S_init(void);

extern I2S_Handle I2S_open(unsigned int index, I2S_Params *params);

extern void I2S_Params_init(I2S_Params *params);

extern int I2S_read(I2S_Handle handle, I2S_BufDesc *desc);

extern int I2S_readIssue(I2S_Handle handle, I2S_BufDesc *desc);

extern size_t I2S_readReclaim(I2S_Handle handle, I2S_BufDesc **pDesc);

extern int I2S_write(I2S_Handle handle, I2S_BufDesc *desc);

extern int I2S_writeIssue(I2S_Handle handle, I2S_BufDesc *desc);

extern size_t I2S_writeReclaim(I2S_Handle handle, I2S_BufDesc **pDesc);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_I2S__include */