I2SCC3200DMA.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_I2SCC3200DMA__include
#define ti_drivers_i2s_I2SCC3200DMA__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/I2S.h>
#include <ti/drivers/ports/HwiP.h>
#include <ti/drivers/ports/SemaphoreP.h>
#include <ti/drivers/utils/List.h>

/* Return codes for I2S_control() */
#define I2SCC3200DMA_SET_ZEROBUF_LEN      I2S_CMD_RESERVED + 0
#define I2SCC3200DMA_SET_EMPTYBUF_LEN     I2S_CMD_RESERVED + 1

/* Value for Invalid Index */
#define I2SCC3200DMA_INDEX_INVALID      0xFF

/*Number of Serial data pins supported*/
#define I2SCC3200DMA_NUM_SERIAL_PINS    2

typedef enum I2SCC3200DMA_DataSize {
    I2SCC3200DMA_16bit = 0,
    I2SCC3200DMA_32bit = 1
} I2SCC3200DMA_DataSize;


/* I2S function table pointer */
extern const I2S_FxnTable I2SCC3200DMA_fxnTable;

/*Zero buffer to write when there is no data from the application*/
extern unsigned short I2SCC3200DMA_zeroBuffer[32];
extern I2S_BufDesc  I2SCC3200DMA_zeroBufDesc;

/*Empty buffer to read into when there is no data requested
  from the application*/
extern unsigned char I2SCC3200DMA_emptyBuffer[32];
extern I2S_BufDesc  I2SCC3200DMA_emptyBufDesc;

typedef struct I2SCC3200DMA_HWAttrs {
    uint32_t baseAddr;
    uint32_t intNum;
    uint32_t intPriority;
    unsigned long rxChannelIndex;
    unsigned long txChannelIndex;
} I2SCC3200DMA_HWAttrs;

typedef struct I2SCC3200DMA_SerialPinConfig {
    unsigned char         pinNumber;

    I2S_PinMode           pinMode;

    I2S_SerInActiveConfig inActiveConfig;

} I2SCC3200DMA_SerialPinConfig;

typedef struct I2SCC3200DMA_SerialPinParams {

    I2SCC3200DMA_SerialPinConfig serialPinConfig[I2SCC3200DMA_NUM_SERIAL_PINS];

} I2SCC3200DMA_SerialPinParams;

typedef struct I2SCC3200DMA_SerialPinVars {
    I2S_DataMode        readWriteMode;
    /* Pointer to read/write callback */
    I2S_Callback        readWriteCallback;
    /* Timeout for read/write semaphore */
    uint32_t            readWriteTimeout;

}I2SCC3200DMA_SerialPinVars;

typedef struct I2SCC3200DMA_Object {
    /* I2S control variables */
    bool                   opened;              /* Has the obj been opened */
    uint32_t               operationMode;       /* Mode of operation of I2S */

    /* I2S serial pin variables */
    I2SCC3200DMA_SerialPinVars serialPinVars[I2SCC3200DMA_NUM_SERIAL_PINS];

    uint16_t               readIndex;           /* read channel Index */
    uint16_t               writeIndex;          /* write channel Index */

    I2SCC3200DMA_DataSize  dmaSize;             /* Config DMA word size  */

    /* I2S OSAL objects */
    SemaphoreP_Handle      writeSem;            /* I2S write semaphore*/
    SemaphoreP_Handle      readSem;             /* I2S read semaphore */
    HwiP_Handle            hwiHandle;

    /* DMA write Ping pong mode */
    bool                   i2sWritePingPongMode;
    /* DMA read Ping pong mode */
    bool                   i2sReadPingPongMode;

    unsigned char         zeroWriteBufLength;

    unsigned char         emptyReadBufLength;

    /* Lists for issue-reclaim mode */
    List_List             readActiveQueue;
    List_List             readDoneQueue;
    List_List             writeActiveQueue;
    List_List             writeDoneQueue;
} I2SCC3200DMA_Object, *I2SCC3200DMA_Handle;

extern void I2SCC3200DMA_Params_init(I2SCC3200DMA_SerialPinParams *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_i2s_I2SCC3200DMA__include */