udrv_spimst.h

Go to the documentation of this file.

#ifndef _UDRV_SPIMST_H_
#define _UDRV_SPIMST_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include "board_basic.h"

typedef enum  {
    UDRV_SPIMST_0 = 0x0,
    UDRV_SPIMST_1 = 0x1,
    UDRV_SPIMST_2 = 0x2,
    UDRV_SPIMST_3 = 0x3,
    UDRV_SPIMST_MAX = 0x4,
} udrv_spimst_port;

typedef enum {
    SPI_MST_CPHA_0          = 0,
    SPI_MST_CPHA_1          = 1
} ENUM_SPI_MST_CPHA_T;

typedef enum {
    SPI_MST_CPOL_0          = 0,
    SPI_MST_CPOL_1          = 1
} ENUM_SPI_MST_CPOL_T;

//The structure of SPI master function 
struct udrv_spimst_api {
    void (*SPIMST_INIT) (udrv_spimst_port port);
    void (*SPIMST_SETUP_MODE) (udrv_spimst_port port, ENUM_SPI_MST_CPHA_T CPHA, ENUM_SPI_MST_CPOL_T CPOL);
    void (*SPIMST_SETUP_FREQ) (udrv_spimst_port port, uint32_t clk_Hz);
    void (*SPIMST_SETUP_BYTE_ORDER) (udrv_spimst_port port, bool msb_first);
    void (*SPIMST_DEINIT) (udrv_spimst_port port);
    int8_t (*SPIMST_TRX) (udrv_spimst_port port, uint8_t *write_data, uint32_t write_length, uint8_t *read_data, uint32_t read_length, uint32_t csn);
    void (*SPIMST_SUSPEND) (void);
    void (*SPIMST_RESUME) (void);
};

void udrv_spimst_init(udrv_spimst_port port);

void udrv_spimst_setup_mode(udrv_spimst_port port, ENUM_SPI_MST_CPHA_T CPHA, ENUM_SPI_MST_CPOL_T CPOL);

void udrv_spimst_setup_freq(udrv_spimst_port port, uint32_t clk_Hz);

void udrv_spimst_setup_byte_order(udrv_spimst_port port, bool msb_first);

void udrv_spimst_deinit(udrv_spimst_port port);

int8_t udrv_spimst_trx(udrv_spimst_port port, uint8_t *write_data, uint32_t write_length, uint8_t *read_data, uint32_t read_length, uint32_t csn);

void udrv_spimst_suspend();

void udrv_spimst_resume();

#ifdef __cplusplus
}
#endif

#endif // _UDRV_SPIMST_H_