MCSPI.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016, 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 MCSPI_H
#define MCSPI_H

#ifdef __cplusplus
extern "C" {
#endif

#include <ti/drv/spi/SPI.h>

#define MCSPI_MAX_NUM_INSTANCES     (SPI_MAX_CONFIG_CNT)

#define MCSPI_MAX_NUM_CHANNELS      (4U)

typedef struct MCSPI_Config_s      *MCSPI_Handle;

typedef void         (*MCSPI_CallbackFxn) (MCSPI_Handle       handle,
                                           SPI_Transaction   *transaction);

typedef struct MCSPI_Params_s {
    SPI_TransferMode    transferMode;       
    uint32_t            transferTimeout;    
    MCSPI_CallbackFxn   transferCallbackFxn;
    SPI_Mode            mode;               
    uint32_t            bitRate;            
    uint32_t            dataSize;           
    SPI_FrameFormat     frameFormat;        
    void               *custom;             
} MCSPI_Params;

typedef void         (*MCSPI_CloseFxn)    (MCSPI_Handle handle);

typedef int32_t      (*MCSPI_ControlFxn)  (MCSPI_Handle handle,
                                           uint32_t     cmd,
                                           const void  *arg);

typedef void         (*MCSPI_InitFxn)     (MCSPI_Handle handle);

typedef MCSPI_Handle (*MCSPI_OpenFxn)     (MCSPI_Handle        handle,
                                           const MCSPI_Params *params);

typedef bool         (*MCSPI_TransferFxn) (MCSPI_Handle     handle,
                                           SPI_Transaction *transaction);

typedef void         (*MCSPI_TransferCancelFxn) (MCSPI_Handle handle);

typedef struct MCSPI_FxnTable_s {
    MCSPI_CloseFxn            closeFxn;

    MCSPI_ControlFxn          controlFxn;

    MCSPI_InitFxn             mcspiInitFxn;

    MCSPI_OpenFxn             openFxn;

    MCSPI_TransferFxn         transferFxn;

    MCSPI_TransferCancelFxn   transferCancelFxn;

} MCSPI_FxnTable;

typedef struct MCSPI_Config_s {
    MCSPI_FxnTable const *fxnTablePtr;

    SPI_Handle            handle;

    uint32_t              chnNum;

} MCSPI_Config;

typedef MCSPI_Config MCSPI_config_list[MCSPI_MAX_NUM_INSTANCES][MCSPI_MAX_NUM_CHANNELS];

extern void MCSPI_close(MCSPI_Handle handle);

extern int32_t MCSPI_control(MCSPI_Handle handle, uint32_t cmd, void *arg);

extern void MCSPI_init(void);

extern MCSPI_Handle MCSPI_open(uint32_t idx, uint32_t channel, MCSPI_Params *params);

extern void MCSPI_Params_init(MCSPI_Params *params);

extern bool MCSPI_transfer(MCSPI_Handle handle, SPI_Transaction *spiTrans);

extern void MCSPI_transferCancel(MCSPI_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* _MCSPI_H */

/* @} */