SPI.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_SPI__include
#define ti_drivers_SPI__include

#ifdef __cplusplus
extern "C" {
#endif

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

#define SPI_CMD_RESERVED            32

#define SPI_STATUS_RESERVED        -32

#define SPI_STATUS_SUCCESS         0

#define SPI_STATUS_ERROR          -1

#define SPI_STATUS_UNDEFINEDCMD   -2

/* Add SPI_CMD_<commands> here */

#define SPI_WAIT_FOREVER ~(0)

typedef struct SPI_Config      *SPI_Handle;

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

typedef struct SPI_Transaction {
    /* User input (write-only) fields */
    size_t     count;      
    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 {
    SPI_MASTER      = 0,    
    SPI_SLAVE       = 1     
} SPI_Mode;

typedef enum SPI_FrameFormat {
    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 {
    SPI_MODE_BLOCKING,
    SPI_MODE_CALLBACK
} SPI_TransferMode;

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

typedef void        (*SPI_CloseFxn)          (SPI_Handle handle);

typedef int         (*SPI_ControlFxn)        (SPI_Handle handle,
                                              unsigned int cmd,
                                              void *arg);

typedef void        (*SPI_InitFxn)           (SPI_Handle handle);

typedef SPI_Handle  (*SPI_OpenFxn)           (SPI_Handle handle,
                                              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 {
    SPI_CloseFxn            closeFxn;

    SPI_ControlFxn          controlFxn;

    SPI_InitFxn             initFxn;

    SPI_OpenFxn             openFxn;

    SPI_TransferFxn         transferFxn;

    SPI_TransferCancelFxn   transferCancelFxn;

    SPI_ServiceISRFxn       serviceISRFxn;
} SPI_FxnTable;

typedef struct SPI_Config {
    SPI_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} SPI_Config;

extern void SPI_close(SPI_Handle handle);

extern int SPI_control(SPI_Handle handle, unsigned int cmd, void *arg);

extern void SPI_init(void);

extern SPI_Handle SPI_open(unsigned int index, SPI_Params *params);

extern void SPI_Params_init(SPI_Params *params);

extern void SPI_serviceISR(SPI_Handle handle);

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

extern void SPI_transferCancel(SPI_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_SPI__include */