xt_hal_spilcd.h

浏览该文件的文档.

 
#ifndef __XT_HAL_SPILCD_H__
#define __XT_HAL_SPILCD_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
/* LCD SPI协议配置 */
#define XT_HAL_SPILCD_SPI_BIDIR_S     (0)
#define XT_HAL_SPILCD_SPI_BIDIR_W     (1)
#define XT_HAL_SPILCD_SPI_DCX_S       (1)
#define XT_HAL_SPILCD_SPI_DCX_W       (1)
#define XT_HAL_SPILCD_SAMP_SEL_S      (2)
#define XT_HAL_SPILCD_SAMP_SEL_W      (1)
#define XT_HAL_SPILCD_READ_DMY_CYC_S  (3)
#define XT_HAL_SPILCD_READ_DMY_CYC_W  (4)
#define XT_HAL_SPILCD_RGB565_SWAP_S   (7)
#define XT_HAL_SPILCD_RGB565_SWAP_W   (1)
 
/* LCD SPI双向模式 */
#define XT_HAL_SPILCD_SPI_UNIDIR      ((0) << XT_HAL_SPILCD_SPI_BIDIR_S) 
#define XT_HAL_SPILCD_SPI_BIDIR       ((1) << XT_HAL_SPILCD_SPI_BIDIR_S) 
 
/* LCD DCX控制 */
#define XT_HAL_SPILCD_DCX_ENCODED     ((0) << XT_HAL_SPILCD_SPI_DCX_S) 
#define XT_HAL_SPILCD_DCX_DEDICATED   ((1) << XT_HAL_SPILCD_SPI_DCX_S) 
 
/* LCD采样时钟 */
#define XT_HAL_SPILCD_SAMPLE_RISE     ((0) << XT_HAL_SPILCD_SAMP_SEL_S) 
#define XT_HAL_SPILCD_SAMPLE_FALL     ((1) << XT_HAL_SPILCD_SAMP_SEL_S) 
 
/* LCD虚拟周期 */
#define XT_HAL_SPILCD_DUMMY_CYCLE(n)  ((n) << XT_HAL_SPILCD_READ_DMY_CYC_S) 
 
/* LCD RGB565字节交换 */
#define XT_HAL_SPILCD_RGB565_NORMAL   ((0) << XT_HAL_SPILCD_RGB565_SWAP_S) 
#define XT_HAL_SPILCD_RGB565_SWAP     ((1) << XT_HAL_SPILCD_RGB565_SWAP_S) 
 
/* ==================== [Typedefs] ========================================== */

enum xt_hal_spilcd_event_id {
    XT_HAL_SPILCD_EVENT_DONE = 0x00, 
    XT_HAL_SPILCD_EVENT_ERROR,       
};

typedef void (*xt_hal_spilcd_cb_t)(uint8_t lcd_id, uint32_t event_id);
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_spilcd_setup(uint8_t lcd_id, 
                             uint8_t csx_pin, uint8_t scl_pin, uint8_t sdi_pin,
                             uint8_t sdo_pin, uint8_t dcx_pin);

xt_err_t xt_hal_spilcd_close(uint8_t lcd_id);

xt_err_t xt_hal_spilcd_set_cb(uint8_t lcd_id, xt_hal_spilcd_cb_t cb);

xt_err_t xt_hal_spilcd_set_sample_edge(uint8_t lcd_id, bool falling);

xt_err_t xt_hal_spilcd_set_rgb565_swap(uint8_t lcd_id, bool enable);

xt_err_t xt_hal_spilcd_set_freq(uint8_t lcd_id, uint32_t freq_hz);

int32_t xt_hal_spilcd_tx_param_block(uint8_t lcd_id, uint8_t cmd, const uint8_t *param, uint32_t len);

int32_t xt_hal_spilcd_rx_param_block(uint8_t lcd_id, uint8_t cmd, uint8_t *param, uint32_t len);

int32_t xt_hal_spilcd_tx_data_0copy(uint8_t lcd_id, uint8_t cmd, const uint8_t *data, uint32_t len);

int32_t xt_hal_spilcd_tx_data_0copy_block(uint8_t lcd_id, uint8_t cmd, const uint8_t *data, uint32_t len);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_spilcd */
 
/* 以下三个函数已过时，不再支持，保留宏定义仅用于兼容旧代码 */
#define xt_hal_spilcd_set_spi_bidir(lcd_id, enable)    ((void)(lcd_id), (void)(enable))
#define xt_hal_spilcd_set_dcx_mode(lcd_id, dedicated)   ((void)(lcd_id), (void)(dedicated))
#define xt_hal_spilcd_set_dummy_cycles(lcd_id, cycles)  ((void)(lcd_id), (void)(cycles))
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_SPILCD_H__ */