Bar Logo 3.8/7.6 kw Totem pole Demonstration Application (Part-No. (not specified))
 
Content
     
Loading...
Searching...
No Matches

This is the generated driver header file for the SPI1 driver. More...

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "spi_client_interface.h"
+ Include dependency graph for spi1.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define SPI1_Client_Initialize   SPI1_Initialize
 This macro defines the Custom Name for SPI1_Initialize API.
 
#define SPI1_Client_Deinitialize   SPI1_Deinitialize
 This macro defines the Custom Name for SPI1_Deinitialize API.
 
#define SPI1_Client_Close   SPI1_Close
 This macro defines the Custom Name for SPI1_Close API.
 
#define SPI1_Client_Open   SPI1_Open
 This macro defines the Custom Name for SPI1_Open API.
 
#define SPI1_Client_ByteExchange   SPI1_ByteExchange
 This macro defines the Custom Name for SPI1_ByteExchange API.
 
#define SPI1_Client_ByteWrite   SPI1_ByteWrite
 This macro defines the Custom Name for SPI1_ByteWrite API.
 
#define SPI1_Client_ByteRead   SPI1_ByteRead
 This macro defines the Custom Name for SPI1_ByteRead API.
 
#define SPI1_Client_IsRxReady   SPI1_IsRxReady
 This macro defines the Custom Name for SPI1_IsRxReady API.
 
#define SPI1_Client_IsTxReady   SPI1_IsTxReady
 This macro defines the Custom Name for SPI1_IsTxReady API.
 

Enumerations

enum  SPI1_CLIENT_USER_CONFIG { CLIENT_CONFIG }
 Enum list is the Custom names for the SPI1 CLIENT multiple configuration, configured by user in MCC Melody user interface. More...
 

Functions

void SPI1_Initialize (void)
 Initializes SPI1 module, using the given initialization data. This function must be called before any other SPI1 function is called.
 
void SPI1_Deinitialize (void)
 Deinitializes the SPI1 to POR values.
 
void SPI1_Close (void)
 Disables the SPI1 module.
 
bool SPI1_Open (uint8_t spiConfigIndex)
 Configures SPI1 module with user defined unique configuration.
 
uint8_t SPI1_ByteExchange (uint8_t byteData)
 Exchanges one byte of data. This is a blocking function.
 
void SPI1_ByteWrite (uint8_t byteData)
 Writes one byte of data.
 
uint8_t SPI1_ByteRead (void)
 Reads one byte of data from SPI1.
 
bool SPI1_IsRxReady (void)
 Returns a boolean value if data is available to read.
 
bool SPI1_IsTxReady (void)
 Returns a boolean value if data can be written.
 

Variables

const struct SPI_CLIENT_INTERFACE SPI1_Client
 Structure object of type SPI_CLIENT_INTERFACE assigned with name displayed in the Melody Driver User interface. A structure pointer can be used to achieve portability across the SPI CLIENT having same interface structure.
 

Detailed Description

SPI1 Generated Driver Header File

Definition in file spi1.h.

Macro Definition Documentation

◆ SPI1_Client_ByteExchange

#define SPI1_Client_ByteExchange   SPI1_ByteExchange

Definition at line 83 of file spi1.h.

◆ SPI1_Client_ByteRead

#define SPI1_Client_ByteRead   SPI1_ByteRead

Definition at line 93 of file spi1.h.

◆ SPI1_Client_ByteWrite

#define SPI1_Client_ByteWrite   SPI1_ByteWrite

Definition at line 88 of file spi1.h.

◆ SPI1_Client_Close

#define SPI1_Client_Close   SPI1_Close

Definition at line 73 of file spi1.h.

◆ SPI1_Client_Deinitialize

#define SPI1_Client_Deinitialize   SPI1_Deinitialize

Definition at line 68 of file spi1.h.

◆ SPI1_Client_Initialize

#define SPI1_Client_Initialize   SPI1_Initialize

Definition at line 63 of file spi1.h.

◆ SPI1_Client_IsRxReady

#define SPI1_Client_IsRxReady   SPI1_IsRxReady

Definition at line 98 of file spi1.h.

◆ SPI1_Client_IsTxReady

#define SPI1_Client_IsTxReady   SPI1_IsTxReady

Definition at line 103 of file spi1.h.

◆ SPI1_Client_Open

#define SPI1_Client_Open   SPI1_Open

Definition at line 78 of file spi1.h.