ble-light/components/driver/spi/spi.h

/**************************************************************************************************
 
  Phyplus Microelectronics Limited confidential and proprietary. 
  All rights reserved.

  IMPORTANT: All rights of this software belong to Phyplus Microelectronics 
  Limited ("Phyplus"). Your use of this Software is limited to those 
  specific rights granted under  the terms of the business contract, the 
  confidential agreement, the non-disclosure agreement and any other forms 
  of agreements as a customer or a partner of Phyplus. You may not use this 
  Software unless you agree to abide by the terms of these agreements. 
  You acknowledge that the Software may not be modified, copied, 
  distributed or disclosed unless embedded on a Phyplus Bluetooth Low Energy 
  (BLE) integrated circuit, either as a product or is integrated into your 
  products.  Other than for the aforementioned purposes, you may not use, 
  reproduce, copy, prepare derivative works of, modify, distribute, perform, 
  display or sell this Software and/or its documentation for any purposes.

  YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
  PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
  INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
  NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
  PHYPLUS OR ITS SUBSIDIARIES BE LIABLE OR OBLIGATED UNDER CONTRACT,
  NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
  LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
  INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
  OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
  OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
  (INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
  
**************************************************************************************************/

/*******************************************************************************
* @file		spi.h
* @brief	Contains all functions support for spi driver
* @version	0.0
* @date		18. Oct. 2017
* @author	qing.han
* 
* Copyright(C) 2016, PhyPlus Semiconductor
* All rights reserved.
*
*******************************************************************************/
#ifndef _SPI_H_
#define _SPI_H_

#include "types.h"
#include "gpio.h"
#include "ap_cp.h"
#include "gpio.h"
#include "common.h"

#define  SPI_MASTER_MODE      1    //define master mode,1:master mode,0:salve mode

#define  SPI_USE_TIMEOUT 1
#define  SPI_OP_TIMEOUT  100        //100ms for an Byte operation
#if(SPI_USE_TIMEOUT == 1)
  #define SPI_INIT_TOUT(to)               int to = hal_systick()
		#define SPI_CHECK_TOUT(to, timeout,loginfo)   {if(hal_ms_intv(to) > timeout){LOG(loginfo);return PPlus_ERR_TIMEOUT;}}
	#else
  #define SPI_INIT_TOUT(to)
  #define SPI_CHECK_TOUT(to, timeout)     false
#endif
	

#define  ENABLE_SPI           Ssix->SSIEN = 1
#define  DISABLE_SPI          Ssix->SSIEN = 0
#define  NUMBER_DATA_RX_FIFO  Ssix->RXFLR
#define  NUMBER_DATA_TX_FIFO  Ssix->TXFLR

#define  SPI_BUSY             0x1
#define  TX_FIFO_NOT_FULL     0x2
#define  TX_FIFO_EMPTY        0x4
#define  RX_FIFO_NOT_EMPTY    0x8



typedef enum{
	SPI_MODE0=0,      //SCPOL=0,SCPH=0
	SPI_MODE1,        //SCPOL=0,SCPH=1
	SPI_MODE2,        //SCPOL=1,SCPH=0
	SPI_MODE3,        //SCPOL=1,SCPH=1
}SPI_SCMOD_e;

typedef enum{
	 SPI_TRXD=0,        //Transmit & Receive
	 SPI_TXD,         //Transmit Only
	 SPI_RXD,         //Receive Only
   SPI_EEPROM,      //EEPROM Read	
}SPI_TMOD_e;

typedef enum{
	 SPI0=0,          //use spi 0
	 SPI1,          //use spi 1
}SPI_INDEX_e;


typedef enum{
	SPI_TX_COMPLETED = 1,
	SPI_RX_COMPLETED,
	SPI_TX_REQ_S,   //slave tx
	SPI_RX_DATA_S,  //slave rx
} SPI_EVT_e;

typedef struct _spi_evt_t{
	uint8_t     id;
	SPI_EVT_e   evt;
	uint8_t*    data;
	uint8_t     len;
}spi_evt_t;

typedef void (*spi_hdl_t)(spi_evt_t* pevt);

typedef struct _spi_Cfg_t{
	GPIO_Pin_e    sclk_pin;
	GPIO_Pin_e    ssn_pin;
	GPIO_Pin_e    MOSI;
	GPIO_Pin_e    MISO;
	uint32_t      baudrate;
	SPI_TMOD_e    spi_tmod;
	SPI_SCMOD_e   spi_scmod;
	bool          int_mode;
	bool          force_cs;
	spi_hdl_t     evt_handler;
}spi_Cfg_t;

typedef enum{
	TRANSMIT_FIFO_EMPTY = 0x01,
	TRANSMIT_FIFO_OVERFLOW = 0x02,
	RECEIVE_FIFO_UNDERFLOW = 0x04,
	RECEIVE_FIFO_OVERFLOW = 0x08,
	RECEIVE_FIFO_FULL = 0x10,
}SPI_INT_STATUS_e;

typedef struct _hal_spi_t{
	SPI_INDEX_e spi_index;
}hal_spi_t;

typedef struct{
	bool busy;
	uint16_t xmit_len;
	uint16_t buf_len; //tx buffer and rx buffer size should same
	uint8_t* tx_buf;
	uint8_t* rx_buf;
	uint16_t tx_offset;
	uint16_t rx_offset;
}spi_xmit_t;

void __attribute__((weak)) hal_SPI0_IRQHandler(void);

void __attribute__((weak)) hal_SPI1_IRQHandler(void);

int hal_spis_clear_rx(hal_spi_t* spi_ptr);
uint32_t hal_spis_rx_len(hal_spi_t* spi_ptr);
int hal_spis_read_rxn(hal_spi_t* spi_ptr, uint8_t* pbuf, uint16_t len);
int hal_spi_bus_init(hal_spi_t* spi_ptr,spi_Cfg_t cfg);
int hal_spis_bus_init(hal_spi_t* spi_ptr,spi_Cfg_t cfg);

int hal_spi_bus_deinit(hal_spi_t* spi_ptr);

int hal_spi_init(SPI_INDEX_e channel);
int hal_spi_transmit(hal_spi_t* spi_ptr,uint8_t* tx_buf,uint8_t* rx_buf,uint16_t len);

int hal_spi_set_tx_buffer(hal_spi_t* spi_ptr,uint8_t* tx_buf,uint16_t len);
int hal_spi_set_int_mode(hal_spi_t* spi_ptr,bool en);
int hal_spi_set_force_cs(hal_spi_t* spi_ptr,bool en);

bool hal_spi_get_transmit_bus_state(hal_spi_t* spi_ptr);
int hal_spi_TxComplete(hal_spi_t* spi_ptr);
int hal_spi_send_byte(hal_spi_t* spi_ptr,uint8_t data);

#endif