SPI.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2023, 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 SPI_H
#define SPI_H

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/csl/soc.h>

#define SPI_CMD_RESERVED            (32U)
#define OSPI_CMD_RESERVED           (32U)

#define SPI_STATUS_RESERVED        (-((int32_t)32))

#define SPI_STATUS_SUCCESS         (int32_t)(0)

#define SPI_STATUS_ERROR          (-((int32_t)1))

#define SPI_STATUS_UNDEFINEDCMD   (-((int32_t)2))

#define SPI_WAIT_FOREVER (~(0U))

typedef struct SPI_Config_s      *SPI_Handle;

typedef enum SPI_Status_s {
    SPI_TRANSFER_COMPLETED = 0,
    SPI_TRANSFER_STARTED,
    SPI_TRANSFER_CANCELED,
    SPI_TRANSFER_FAILED,
    SPI_TRANSFER_CSN_DEASSERT,
    SPI_TRANSFER_TIMEOUT
} SPI_Status;

typedef struct SPI_Transaction_s {
    /* User input (write-only) fields */
    size_t     count;      
    uint64_t   txDmaBuf;      
    uint64_t   rxDmaBuf;      
    void      *txBuf;      
    void      *rxBuf;      
    void      *arg;        
    /* User output (read-only) fields */
    SPI_Status status;     
    /* Driver-use only fields */
} SPI_Transaction;

typedef void        (*SPI_CallbackFxn) (SPI_Handle handle,
                                        SPI_Transaction * transaction);
typedef enum SPI_Mode_s {
    SPI_MASTER      = 0,    
    SPI_SLAVE       = 1     
} SPI_Mode;

typedef enum SPI_FrameFormat_s {
    SPI_POL0_PHA0   = 0,    
    SPI_POL0_PHA1   = 1,    
    SPI_POL1_PHA0   = 2,    
    SPI_POL1_PHA1   = 3,    
    SPI_TI          = 4,    
    SPI_MW          = 5     
} SPI_FrameFormat;

typedef enum SPI_TransferMode_s {
    SPI_MODE_BLOCKING,
    SPI_MODE_CALLBACK
} SPI_TransferMode;

typedef struct SPI_Params_s {
    SPI_TransferMode    transferMode;       
    uint32_t            transferTimeout;    
    SPI_CallbackFxn     transferCallbackFxn;
    SPI_Mode            mode;               
    uint32_t            bitRate;            
    uint32_t            dataSize;           
    SPI_FrameFormat     frameFormat;        
    void               *custom;             
} SPI_Params;

typedef void        (*SPI_CloseFxn)          (SPI_Handle handle);

typedef int32_t         (*SPI_ControlFxn)        (SPI_Handle handle,
                                              uint32_t cmd,
                                              const void *arg);

typedef void        (*SPI_InitFxn)           (SPI_Handle handle);

typedef SPI_Handle  (*SPI_OpenFxn)           (SPI_Handle handle,
                                              const SPI_Params *params);

typedef void        (*SPI_ServiceISRFxn)     (SPI_Handle handle);

typedef bool        (*SPI_TransferFxn)       (SPI_Handle handle,
                                              SPI_Transaction *transaction);

typedef void        (*SPI_TransferCancelFxn) (SPI_Handle handle);

typedef struct SPI_FxnTable_s {
    SPI_CloseFxn            closeFxn;

    SPI_ControlFxn          controlFxn;

    SPI_InitFxn             spiInitFxn;

    SPI_OpenFxn             openFxn;

    SPI_TransferFxn         transferFxn;

    SPI_TransferCancelFxn   transferCancelFxn;

    SPI_ServiceISRFxn       serviceISRFxn;
} SPI_FxnTable;

typedef struct SPI_Config_s {
    SPI_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} SPI_Config;

#define SPI_MAX_CONFIG_CNT (CSL_MCSPI_PER_CNT)
#define SPI_MAX_DOMAIN_CNT (CSL_MCSPI_DOMAIN_CNT)
typedef SPI_Config SPI_config_list[SPI_MAX_DOMAIN_CNT][SPI_MAX_CONFIG_CNT];

typedef enum OSPI_Status_s {
    OSPI_TRANSFER_COMPLETED = 0,
    OSPI_TRANSFER_STARTED,
    OSPI_TRANSFER_CANCELED,
    OSPI_TRANSFER_FAILED,
    OSPI_TRANSFER_CSN_DEASSERT,
    OSPI_TRANSFER_TIMEOUT
} OSPI_Status;

typedef struct OSPI_Transaction_s {
    /* User input (write-only) fields */
    size_t     count;      
    void      *txBuf;      
    void      *rxBuf;      
    void      *arg;        
    /* User output (read-only) fields */
    OSPI_Status status;     
    /* Driver-use only fields */
} OSPI_Transaction;

typedef struct OSPI_Config_s      *OSPI_Handle;

typedef void       (*OSPI_CallbackFxn) (OSPI_Handle handle,
                                        OSPI_Transaction * transaction);
typedef enum OSPI_Mode_s {
    OSPI_MASTER      = 0,    
    OSPI_SLAVE       = 1     
} OSPI_Mode;

typedef enum OSPI_FrameFormat_s {
    OSPI_POL0_PHA0   = 0,    
    OSPI_POL0_PHA1   = 1,    
    OSPI_POL1_PHA0   = 2,    
    OSPI_POL1_PHA1   = 3,    
    OSPI_TI          = 4,    
    OSPI_MW          = 5     
} OSPI_FrameFormat;

typedef enum OSPI_TransferMode_s {
    OSPI_MODE_BLOCKING,
    OSPI_MODE_CALLBACK
} OSPI_TransferMode;

typedef struct OSPI_Params_s {
    OSPI_TransferMode   transferMode;       
    uint32_t            transferTimeout;    
    OSPI_CallbackFxn    transferCallbackFxn;
    OSPI_Mode           mode;               
    uint32_t            bitRate;            
    uint32_t            dataSize;           
    OSPI_FrameFormat    frameFormat;        
    void               *custom;             
} OSPI_Params;

typedef void        (*OSPI_CloseFxn)          (OSPI_Handle handle);

typedef int32_t         (*OSPI_ControlFxn)        (OSPI_Handle handle,
                                              uint32_t cmd,
                                              const void *arg);

typedef void        (*OSPI_InitFxn)           (OSPI_Handle handle);

typedef OSPI_Handle  (*OSPI_OpenFxn)           (OSPI_Handle handle,
                                              const OSPI_Params *params);

typedef void        (*OSPI_ServiceISRFxn)     (OSPI_Handle handle);

typedef bool        (*OSPI_TransferFxn)       (OSPI_Handle handle,
                                              OSPI_Transaction *transaction);

typedef void        (*OSPI_TransferCancelFxn) (OSPI_Handle handle);


typedef struct OSPI_FxnTable_s {
    OSPI_CloseFxn            closeFxn;

    OSPI_ControlFxn          controlFxn;

    OSPI_InitFxn             spiInitFxn;

    OSPI_OpenFxn             openFxn;

    OSPI_TransferFxn         transferFxn;

    OSPI_TransferCancelFxn   transferCancelFxn;

    OSPI_ServiceISRFxn       serviceISRFxn;
} OSPI_FxnTable;

typedef struct OSPI_Config_s {
    OSPI_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} OSPI_Config;

#define OSPI_MAX_CONFIG_CNT (CSL_OSPI_PER_CNT)
#define OSPI_MAX_DOMAIN_CNT (CSL_OSPI_DOMAIN_CNT)
typedef OSPI_Config OSPI_config_list[OSPI_MAX_DOMAIN_CNT][OSPI_MAX_CONFIG_CNT];

extern void SPI_close(SPI_Handle handle);

extern int32_t SPI_control(SPI_Handle handle, uint32_t cmd, void *arg);

extern void SPI_init(void);

extern SPI_Handle SPI_open(uint32_t domain, uint32_t idx, SPI_Params *params);

extern void OSPI_close(OSPI_Handle handle);

extern int32_t OSPI_control(OSPI_Handle handle, uint32_t cmd, void *arg);

extern void OSPI_init(void);

extern OSPI_Handle OSPI_open(uint32_t domain, uint32_t idx, OSPI_Params *params);

extern void OSPI_Params_init(OSPI_Params *params);

extern bool OSPI_transfer(OSPI_Handle handle, OSPI_Transaction *spiTrans);

extern void SPI_Params_init(SPI_Params *params);

extern void SPI_serviceISR(SPI_Handle handle);

extern bool SPI_transfer(SPI_Handle handle, SPI_Transaction *spiTrans);

extern void SPI_transferCancel(SPI_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* _SPI_H */

/* @} */