hal_spi.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 * --  _____       ______  _____                                              -
 * -- |_   _|     |  ____|/ ____|                                             -
 * --   | |  _ __ | |__  | (___    Institute of Embedded Systems              -
 * --   | | | '_ \|  __|  \___ \   Zurich University of                       -
 * --  _| |_| | | | |____ ____) |  Applied Sciences                           -
 * -- |_____|_| |_|______|_____/   8401 Winterthur, Switzerland               -
 * ------------------------------------------------------------------------- */
/* Re-definition guard */
#ifndef _HAL_SPI_H
#define _HAL_SPI_H

/* Removing weak tag for gcc usage*/
#ifdef TESTING
    #define __weak
#endif


/* User includes */
#include "reg_stm32f4xx.h"
#include "hal_common.h"


/* -- Type definitions
 * ------------------------------------------------------------------------- */

 typedef enum {
     HAL_SPI_MODE_SLAVE = 0x0,      
     HAL_SPI_MODE_MASTER = 0x1      
 } hal_spi_mode_t;

 
 typedef enum {
     HAL_SPI_DIR_BOTH = 0x0,        
     HAL_SPI_DIR_READ = 0x2,        
     HAL_SPI_DIR_WRITE = 0x3        
 } hal_spi_dir_t;

 
 typedef enum {
     HAL_SPI_SIZE_8B = 0u,          
     HAL_SPI_SIZE_16B = 1u          
 } hal_spi_size_t;
 
 
 typedef enum {
     HAL_SPI_NSS_HW = 0x0,          
     HAL_SPI_NSS_SW = 0x3,          
 } hal_spi_nss_t;

 
 typedef enum {
     HAL_SPI_PRE_2 = 0u,            
     HAL_SPI_PRE_4 = 1u,            
     HAL_SPI_PRE_8 = 2u,            
     HAL_SPI_PRE_16 = 3u,           
     HAL_SPI_PRE_32 = 4u,           
     HAL_SPI_PRE_64 = 5u,           
     HAL_SPI_PRE_128 = 6u,          
     HAL_SPI_PRE_256 = 7u           
 } hal_spi_prescaler_t;

 
 typedef enum {
     HAL_SPI_FRAME_MOTOROLLA = 0x0,     
     HAL_SPI_FRAME_TI = 0x1             
 } hal_spi_frame_t;

 
typedef struct {
    hal_spi_mode_t mode;                
    hal_spi_dir_t direction;            
    hal_spi_size_t data_size;           
    hal_spi_nss_t nss_mode;             
    hal_spi_prescaler_t prescaler;      
    hal_spi_frame_t frame_type;         
    hal_bool_t hw_crc;                  
} hal_spi_init_t;


/* -- Public function declarations
 * ------------------------------------------------------------------------- */

void hal_spi_reset(reg_spi_t *spi)
__attribute__((deprecated("Please use SPIx_RESET().")));

void hal_spi_init(reg_spi_t *spi, hal_spi_init_t init);

uint8_t hal_spi_read_write(reg_spi_t *spi, uint8_t write_byte);

 
#endif