OLE Developer Guide  Latest Git
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
spi.h
Go to the documentation of this file.
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * spi.h
17  * Copyright (C) 2015 Simon Newton
18  */
19 
39 #ifndef FIRMWARE_SRC_SPI_H_
40 #define FIRMWARE_SRC_SPI_H_
41 
42 #include <stdbool.h>
43 #include <stdint.h>
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
52 typedef enum {
53  SPI_BEGIN_TRANSFER,
54  SPI_COMPLETE_TRANSFER
55 } SPIEventType;
56 
61 typedef void (*SPI_Callback)(SPIEventType event);
62 
79 bool SPI_QueueTransfer(const uint8_t *output,
80  unsigned int output_length,
81  uint8_t *input,
82  unsigned int input_length,
83  SPI_Callback callback);
87 void SPI_Initialize();
88 
92 void SPI_Tasks();
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif // FIRMWARE_SRC_SPI_H_
99 
void(* SPI_Callback)(SPIEventType event)
The callback run before and after the SPI transfer begins.
Definition: spi.h:61
void SPI_Initialize()
Initialize the SPI driver.
void SPI_Tasks()
The tasks function, this should be called from the main event loop.
SPIEventType
SPI Event types.
Definition: spi.h:52
bool SPI_QueueTransfer(const uint8_t *output, unsigned int output_length, uint8_t *input, unsigned int input_length, SPI_Callback callback)
Queue an SPI transfer.