aboutsummaryrefslogtreecommitdiff
path: root/spi.h
blob: e1a1a5c69b4d409ecc3a0005ef39b2a5fffd76e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#include <avr/io.h>
#include <avr/interrupt.h>
#include <stdint.h>

#include "mcu/mcu_def.h"
#include "buffers.h"

#ifndef _IOE_SPI_H_
#define _IOE_SPI_H_

#ifndef MCUSUPPORT_SPI
#error "No SPI interface is known on your mcu."
#endif

enum spiMode {
    SPI_MODE_MASTER,
    SPI_MODE_SLAVE
};


/*
 * Initialize SPI
 *
 *  Parameters:
 *    mode - Specify mode of SPI interface
 *
 * NOTE: Global interrupt must be enabled for right function of SPI.
 * { SREG |= _BV(7) }
 */
void spi_init(enum spiMode mode);
/*
 * Returns NULL when device is not busy.
 * When device is busy return values in non-zero.
 */
int8_t spi_busy(void);
/*
 * Blocks processor until device is not busy.
 */
void spi_join(void);
/*
 * Swap bytes with slave over SPI.
 * This function blocks execution until device isn't busy (transfer completed).
 * WARNING: Invoke this only when interface is initialized in MASTER mode.
 */
uint8_t spi_send(uint8_t data);
/*
 * Transfer byte to slave over SPI.
 * This function isn't blocking execution until transfer is complete.
 * Always call spi_join before this function when called outside of spi_receive().
 * WARNING: Invoke this only when interface is initialized in MASTER mode.
 */
void spi_transfer(uint8_t data);
/*
 * Expose data for next master request.
 * Please don't use this when device is busy.
 * Best place to call this is spi_receive().
 * WARNING: Invoke this only when interface is initialized in SLAVE mode.
 */
void spi_expose(uint8_t data);

/*
 * This function is called every time transfer is finished.
 * And until return from this function interrupts are disabled.
 */
extern void (*spi_receive)(uint8_t data);

#endif /* _IOE_SPI_H_ */