Hanna
Sourcecode Batteriemanagementsystem
spi_master.h
gehe zur Dokumentation dieser Datei
1 
46 #ifndef _SPI_MASTER_H_
47 #define _SPI_MASTER_H_
48 
49 #include "compiler.h"
50 #include "port_driver.h"
51 
52 #ifndef _USART_H_
53 
62 enum status_code {
63  STATUS_OK = 0,
64  ERR_IO_ERROR = -1,
65  ERR_FLUSHED = -2,
66  ERR_TIMEOUT = -3,
67  ERR_BAD_DATA = -4,
68  ERR_PROTOCOL = -5,
69  ERR_UNSUPPORTED_DEV = -6,
70  ERR_NO_MEMORY = -7,
71  ERR_INVALID_ARG = -8,
72  ERR_BAD_ADDRESS = -9,
73  ERR_BUSY = -10,
74  ERR_BAD_FORMAT = -11,
75  ERR_NO_TIMER = -12,
76  ERR_TIMER_ALREADY_RUNNING = -13,
77  ERR_TIMER_NOT_RUNNING = -14,
78 
88  OPERATION_IN_PROGRESS = -128,
89 };
90 
91 
92 
93 typedef enum status_code status_code_t;
94 #endif
95 
106 int8_t spi_xmega_set_baud_div(SPI_t *spi, uint32_t baudrate, uint32_t clkper_hz);
107 
112 static inline void spi_enable(SPI_t *spi)
113 {
114  spi->CTRL |= SPI_ENABLE_bm;
115 }
116 
125 static inline void spi_disable(SPI_t *spi)
126 {
127  spi->CTRL &= ~SPI_ENABLE_bm;
128 }
129 
136 static inline bool spi_is_enabled(SPI_t *spi)
137 {
138  return spi->CTRL & SPI_ENABLE_bm ? true : false;
139 }
140 
147 static inline void spi_put(SPI_t *spi, uint8_t data)
148 {
149  spi->DATA = data;
150 }
151 
158 static inline uint8_t spi_get(SPI_t *spi)
159 {
160  return spi->DATA;
161 }
162 
169 static inline bool spi_is_tx_ok(SPI_t *spi)
170 {
171  return spi->STATUS & SPI_IF_bm ? true : false;
172 }
173 
180 static inline void spi_enable_master_mode(SPI_t *spi)
181 {
182  spi->CTRL |= SPI_MASTER_bm;
183 }
184 
187 
195 //# include "ioport_compat.h"
196 
210 //#include "conf_spi_master.h"
212 
214 #ifndef CONFIG_SPI_MASTER_DUMMY
215 #define CONFIG_SPI_MASTER_DUMMY 0xFF
216 #endif
217 
222 #define SPI_CPHA (1 << 0)
223 
227 #define SPI_CPOL (1 << 1)
228 
232 #define SPI_MODE_0 0
233 
236 #define SPI_MODE_1 (SPI_CPHA)
237 
240 #define SPI_MODE_2 (SPI_CPOL)
241 
244 #define SPI_MODE_3 (SPI_CPOL | SPI_CPHA)
245 
246 typedef uint8_t spi_flags_t;
247 typedef uint32_t board_spi_select_id_t;
248 
250 struct spi_device {
252  port_pin_t id;
253 };
254 
260 extern void spi_master_init(SPI_t *spi);
261 
276 extern void spi_master_setup_device(SPI_t *spi, struct spi_device *device,
277  spi_flags_t flags, unsigned long baud_rate,
278  board_spi_select_id_t sel_id);
279 
284 extern void spi_enable(SPI_t *spi);
285 
294 extern void spi_disable(SPI_t *spi);
295 
296 
303 extern bool spi_is_enabled(SPI_t *spi);
304 
314 extern void spi_select_device(SPI_t *spi, struct spi_device *device);
315 
326 extern void spi_deselect_device(SPI_t *spi, struct spi_device *device);
327 
334 __always_inline static void spi_write_single(SPI_t *spi, uint8_t data)
335 {
336  spi_put(spi,data);
337 }
338 
350 extern status_code_t spi_write_packet(SPI_t *spi,const uint8_t *data, size_t len);
351 
352 
359 inline static void spi_read_single(SPI_t *spi, uint8_t *data)
360 {
361  *data=spi_get(spi);
362 }
363 
375 extern status_code_t spi_read_packet(SPI_t *spi, uint8_t *data, size_t len);
376 
385 inline static bool spi_is_tx_empty(SPI_t *spi)
386 {
387  return spi_is_tx_ok(spi);
388 }
389 
398 inline static bool spi_is_tx_ready(SPI_t *spi)
399 {
400  return spi_is_tx_ok(spi);
401 }
402 
409 inline static bool spi_is_rx_full(SPI_t *spi)
410 {
411  return spi_is_tx_ok(spi);
412 }
413 
420 inline static bool spi_is_rx_ready(SPI_t *spi)
421 {
422  return spi_is_tx_ok(spi);
423 }
424 
426 
427 
428 
429 
430 #endif // _SPI_MASTER_H_
spi_is_rx_full
static bool spi_is_rx_full(SPI_t *spi)
Tests if the SPI contains a received character.
Definition: spi_master.h:409
ERR_BUSY
Resource is busy.
Definition: spi_master.h:73
spi_disable
static void spi_disable(SPI_t *spi)
Disables the SPI.
Definition: spi_master.h:125
spi_enable_master_mode
static void spi_enable_master_mode(SPI_t *spi)
Activate SPI master mode of a SPI peripheral.
Definition: spi_master.h:180
ERR_BAD_FORMAT
Data format not recognized.
Definition: spi_master.h:74
spi_is_enabled
static bool spi_is_enabled(SPI_t *spi)
Tests if the SPI is enabled.
Definition: spi_master.h:136
spi_device
Polled SPI device definition.
Definition: spi_master.h:250
ERR_FLUSHED
Request flushed from queue.
Definition: spi_master.h:65
spi_device::id
port_pin_t id
Board specific select id.
Definition: spi_master.h:252
compiler.h
Commonly used includes, types and macros.
spi_read_single
static void spi_read_single(SPI_t *spi, uint8_t *data)
Receive one byte from a SPI device.
Definition: spi_master.h:359
ERR_IO_ERROR
I/O error.
Definition: spi_master.h:64
spi_master_init
void spi_master_init(SPI_t *spi)
Initializes the SPI in master mode.
Definition: spi_master.c:126
spi_put
static void spi_put(SPI_t *spi, uint8_t data)
Put one data byte to a SPI peripheral.
Definition: spi_master.h:147
ERR_TIMER_NOT_RUNNING
Timer not running.
Definition: spi_master.h:77
spi_enable
static void spi_enable(SPI_t *spi)
Enables the SPI.
Definition: spi_master.h:112
ERR_INVALID_ARG
Invalid argument.
Definition: spi_master.h:71
ERR_TIMER_ALREADY_RUNNING
Timer already running.
Definition: spi_master.h:76
port_driver.h
XMEGA I/O Port driver header file.
OPERATION_IN_PROGRESS
Operation in progress.
Definition: spi_master.h:88
STATUS_OK
Success.
Definition: spi_master.h:63
ERR_NO_TIMER
No timer available.
Definition: spi_master.h:75
ERR_BAD_ADDRESS
Bad address.
Definition: spi_master.h:72
spi_read_packet
status_code_t spi_read_packet(SPI_t *spi, uint8_t *data, size_t len)
Receive a sequence of bytes from a SPI device.
Definition: spi_master.c:223
ERR_NO_MEMORY
Insufficient memory.
Definition: spi_master.h:70
spi_is_rx_ready
static bool spi_is_rx_ready(SPI_t *spi)
Checks if all reception is ready.
Definition: spi_master.h:420
ERR_UNSUPPORTED_DEV
Unsupported device.
Definition: spi_master.h:69
spi_get
static uint8_t spi_get(SPI_t *spi)
Get one data byte to a SPI peripheral.
Definition: spi_master.h:158
spi_write_single
static __always_inline void spi_write_single(SPI_t *spi, uint8_t data)
Write one byte to a SPI device.
Definition: spi_master.h:334
ERR_BAD_DATA
Data integrity check failed.
Definition: spi_master.h:67
ERR_PROTOCOL
Protocol error.
Definition: spi_master.h:68
spi_is_tx_ok
static bool spi_is_tx_ok(SPI_t *spi)
Tests if the SPI contains a received character.
Definition: spi_master.h:169
ERR_TIMEOUT
Operation timed out.
Definition: spi_master.h:66
spi_master_setup_device
void spi_master_setup_device(SPI_t *spi, struct spi_device *device, spi_flags_t flags, unsigned long baud_rate, board_spi_select_id_t sel_id)
Setup a SPI device.
spi_xmega_set_baud_div
int8_t spi_xmega_set_baud_div(SPI_t *spi, uint32_t baudrate, uint32_t clkper_hz)
Calculates the SPI baudrate divider.
Definition: spi_master.c:59
spi_is_tx_empty
static bool spi_is_tx_empty(SPI_t *spi)
Checks if all transmissions are complete.
Definition: spi_master.h:385
status_code
status_code
Definition: spi_master.h:62
spi_is_tx_ready
static bool spi_is_tx_ready(SPI_t *spi)
Checks if all transmissions is ready.
Definition: spi_master.h:398
spi_select_device
void spi_select_device(SPI_t *spi, struct spi_device *device)
Select given device on the SPI bus.
Definition: spi_master.c:247
spi_deselect_device
void spi_deselect_device(SPI_t *spi, struct spi_device *device)
Deselect given device on the SPI bus.
Definition: spi_master.c:261
spi_write_packet
status_code_t spi_write_packet(SPI_t *spi, const uint8_t *data, size_t len)
Send a sequence of bytes to a SPI device.
Definition: spi_master.c:200
__always_inline
#define __always_inline
The function should always be inlined.
Definition: compiler.h:127
by Hanna