projects
/
pub
/
lufa.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add script reading bootloader flags
[pub/lufa.git]
/
LUFA
/
Drivers
/
Peripheral
/
XMEGA
/
SerialSPI_XMEGA.h
diff --git
a/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
b/LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
index
7d1e6c1
..
cb86a99
100644
(file)
--- a/
LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
+++ b/
LUFA/Drivers/Peripheral/XMEGA/SerialSPI_XMEGA.h
@@
-1,13
+1,13
@@
/*
LUFA Library
/*
LUFA Library
- Copyright (C) Dean Camera, 20
12
.
+ Copyright (C) Dean Camera, 20
21
.
dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
*/
/*
dean [at] fourwalledcubicle [dot] com
www.lufa-lib.org
*/
/*
- Copyright 20
12
Dean Camera (dean [at] fourwalledcubicle [dot] com)
+ Copyright 20
21
Dean Camera (dean [at] fourwalledcubicle [dot] com)
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
@@
-18,7
+18,7
@@
advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
advertising or publicity pertaining to distribution of the
software without specific, written prior permission.
- The author disclaim all warranties with regard to this
+ The author disclaim
s
all warranties with regard to this
software, including all implied warranties of merchantability
and fitness. In no event shall the author be liable for any
special, indirect or consequential damages or any damages
software, including all implied warranties of merchantability
and fitness. In no event shall the author be liable for any
special, indirect or consequential damages or any damages
@@
-29,7
+29,7
@@
*/
/** \file
*/
/** \file
- * \brief
Serial USART Master SPI Mode
Peripheral Driver (XMEGA)
+ * \brief
Master SPI Mode Serial USART
Peripheral Driver (XMEGA)
*
* On-chip Master SPI mode USART driver for the XMEGA AVR microcontrollers.
*
*
* On-chip Master SPI mode USART driver for the XMEGA AVR microcontrollers.
*
@@
-38,26
+38,26
@@
*/
/** \ingroup Group_SerialSPI
*/
/** \ingroup Group_SerialSPI
- * \defgroup Group_SerialSPI_XMEGA Serial USART Peripheral Driver (XMEGA)
+ * \defgroup Group_SerialSPI_XMEGA
Master SPI Mode
Serial USART Peripheral Driver (XMEGA)
*
*
- * \section Sec_ModDescription Module Description
+ * \section Sec_
SerialSPI_XMEGA_
ModDescription Module Description
* On-chip serial USART driver for the XMEGA AVR microcontrollers.
*
* \note This file should not be included directly. It is automatically included as needed by the ADC driver
* dispatch header located in LUFA/Drivers/Peripheral/SerialSPI.h.
*
* On-chip serial USART driver for the XMEGA AVR microcontrollers.
*
* \note This file should not be included directly. It is automatically included as needed by the ADC driver
* dispatch header located in LUFA/Drivers/Peripheral/SerialSPI.h.
*
- * \section Sec_ExampleUsage Example Usage
+ * \section Sec_
SerialSPI_XMEGA_
ExampleUsage Example Usage
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialize the Master SPI mode USART driver before first use, with 1Mbit baud
* The following snippet is an example of how this module may be used within a typical
* application.
*
* \code
* // Initialize the Master SPI mode USART driver before first use, with 1Mbit baud
- * SerialSPI_Init(&USARTD
, (USART_SPI_SCK_LEAD_RISING | SPI_SAMPLE_LEADING |
SPI_ORDER_MSB_FIRST), 1000000);
+ * SerialSPI_Init(&USARTD
0, (USART_SPI_SCK_LEAD_RISING | USART_SPI_SAMPLE_LEADING | USART_
SPI_ORDER_MSB_FIRST), 1000000);
*
* // Send several bytes, ignoring the returned data
*
* // Send several bytes, ignoring the returned data
- * SerialSPI_SendByte(&USARTD, 0x01);
- * SerialSPI_SendByte(&USARTD, 0x02);
- * SerialSPI_SendByte(&USARTD, 0x03);
+ * SerialSPI_SendByte(&USARTD
0
, 0x01);
+ * SerialSPI_SendByte(&USARTD
0
, 0x02);
+ * SerialSPI_SendByte(&USARTD
0
, 0x03);
*
* // Receive several bytes, sending a dummy 0x00 byte each time
* uint8_t Byte1 = SerialSPI_ReceiveByte(&USARTD);
*
* // Receive several bytes, sending a dummy 0x00 byte each time
* uint8_t Byte1 = SerialSPI_ReceiveByte(&USARTD);
@@
-65,7
+65,7
@@
* uint8_t Byte3 = SerialSPI_ReceiveByte(&USARTD);
*
* // Send a byte, and store the received byte from the same transaction
* uint8_t Byte3 = SerialSPI_ReceiveByte(&USARTD);
*
* // Send a byte, and store the received byte from the same transaction
- * uint8_t ResponseByte = SerialSPI_TransferByte(&USARTD, 0xDC);
+ * uint8_t ResponseByte = SerialSPI_TransferByte(&USARTD
0
, 0xDC);
* \endcode
*
* @{
* \endcode
*
* @{
@@
-97,31
+97,31
@@
/* Public Interface - May be used in end-application: */
/* Macros: */
/** \name SPI SCK Polarity Configuration Masks */
/* Public Interface - May be used in end-application: */
/* Macros: */
/** \name SPI SCK Polarity Configuration Masks */
- /
/@{
- /** SPI clock polarity mask for \
c
SerialSPI_Init(). Indicates that the SCK should lead on the rising edge. */
+ /
**@{*/
+ /** SPI clock polarity mask for \
ref
SerialSPI_Init(). Indicates that the SCK should lead on the rising edge. */
#define USART_SPI_SCK_LEAD_RISING 0
#define USART_SPI_SCK_LEAD_RISING 0
- /
/@}
+ /
**@}*/
/** \name SPI Sample Edge Configuration Masks */
/** \name SPI Sample Edge Configuration Masks */
- /
/@{
- /** SPI data sample mode mask for \
c
SerialSPI_Init(). Indicates that the data should sampled on the leading edge. */
+ /
**@{*/
+ /** SPI data sample mode mask for \
ref
SerialSPI_Init(). Indicates that the data should sampled on the leading edge. */
#define USART_SPI_SAMPLE_LEADING 0
#define USART_SPI_SAMPLE_LEADING 0
- /** SPI data sample mode mask for \
c
SerialSPI_Init(). Indicates that the data should be sampled on the trailing edge. */
- #define USART_SPI_SAMPLE_TRAILING
USART_UPCHA_bm
- /
/@}
+ /** SPI data sample mode mask for \
ref
SerialSPI_Init(). Indicates that the data should be sampled on the trailing edge. */
+ #define USART_SPI_SAMPLE_TRAILING
(1 << 1)
+ /
**@}*/
/** \name SPI Data Ordering Configuration Masks */
/** \name SPI Data Ordering Configuration Masks */
- /
/@{
- /** SPI data order mask for \
c Serial_SPI
Init(). Indicates that data should be shifted out MSB first. */
+ /
**@{*/
+ /** SPI data order mask for \
ref SerialSPI_
Init(). Indicates that data should be shifted out MSB first. */
#define USART_SPI_ORDER_MSB_FIRST 0
#define USART_SPI_ORDER_MSB_FIRST 0
- /** SPI data order mask for \
c Serial_SPI
Init(). Indicates that data should be shifted out LSB first. */
- #define USART_SPI_ORDER_LSB_FIRST
USART_UDORD_bm
- /
/@}
+ /** SPI data order mask for \
ref SerialSPI_
Init(). Indicates that data should be shifted out LSB first. */
+ #define USART_SPI_ORDER_LSB_FIRST
(1 << 2)
+ /
**@}*/
/* Inline Functions: */
/* Inline Functions: */
- /** Initialize the USART module in Master SPI mode.
+ /** Initialize the USART module in Master SPI mode.
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
* \param[in] SPIOptions USART SPI Options, a mask consisting of one of each of the \c USART_SPI_SCK_*,
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
* \param[in] SPIOptions USART SPI Options, a mask consisting of one of each of the \c USART_SPI_SCK_*,
@@
-130,28
+130,32
@@
*/
static inline void SerialSPI_Init(USART_t* const USART,
const uint8_t SPIOptions,
*/
static inline void SerialSPI_Init(USART_t* const USART,
const uint8_t SPIOptions,
+ const uint32_t BaudRate) ATTR_NON_NULL_PTR_ARG(1);
+ static inline void SerialSPI_Init(USART_t* const USART,
+ const uint8_t SPIOptions,
const uint32_t BaudRate)
{
uint16_t BaudValue = SERIAL_SPI_UBBRVAL(BaudRate);
const uint32_t BaudRate)
{
uint16_t BaudValue = SERIAL_SPI_UBBRVAL(BaudRate);
-
+
USART->BAUDCTRLB = (BaudValue >> 8);
USART->BAUDCTRLA = (BaudValue & 0xFF);
USART->BAUDCTRLB = (BaudValue >> 8);
USART->BAUDCTRLA = (BaudValue & 0xFF);
-
+
USART->CTRLC = (USART_CMODE_MSPI_gc | SPIOptions);
USART->CTRLB = (USART_RXEN_bm | USART_TXEN_bm);
}
USART->CTRLC = (USART_CMODE_MSPI_gc | SPIOptions);
USART->CTRLB = (USART_RXEN_bm | USART_TXEN_bm);
}
-
+
/** Turns off the USART driver, disabling and returning used hardware to their default configuration.
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
*/
/** Turns off the USART driver, disabling and returning used hardware to their default configuration.
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
*/
+ static inline void SerialSPI_Disable(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
static inline void SerialSPI_Disable(USART_t* const USART)
{
USART->CTRLA = 0;
USART->CTRLB = 0;
USART->CTRLC = 0;
}
static inline void SerialSPI_Disable(USART_t* const USART)
{
USART->CTRLA = 0;
USART->CTRLB = 0;
USART->CTRLC = 0;
}
-
+
/** Sends and receives a byte through the USART SPI interface, blocking until the transfer is complete.
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
/** Sends and receives a byte through the USART SPI interface, blocking until the transfer is complete.
*
* \param[in,out] USART Pointer to the base of the USART peripheral within the device.
@@
-160,6
+164,8
@@
* \return Response byte from the attached SPI device.
*/
static inline uint8_t SerialSPI_TransferByte(USART_t* const USART,
* \return Response byte from the attached SPI device.
*/
static inline uint8_t SerialSPI_TransferByte(USART_t* const USART,
+ const uint8_t DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+ static inline uint8_t SerialSPI_TransferByte(USART_t* const USART,
const uint8_t DataByte)
{
USART->DATA = DataByte;
const uint8_t DataByte)
{
USART->DATA = DataByte;
@@
-175,11
+181,11
@@
* \param[in] DataByte Byte to send through the USART SPI interface.
*/
static inline void SerialSPI_SendByte(USART_t* const USART,
* \param[in] DataByte Byte to send through the USART SPI interface.
*/
static inline void SerialSPI_SendByte(USART_t* const USART,
+ const uint8_t DataByte) ATTR_ALWAYS_INLINE ATTR_NON_NULL_PTR_ARG(1);
+ static inline void SerialSPI_SendByte(USART_t* const USART,
const uint8_t DataByte)
{
const uint8_t DataByte)
{
- USART->DATA = DataByte;
- while (!(USART->STATUS & USART_TXCIF_bm));
- USART->STATUS = USART_TXCIF_bm;
+ SerialSPI_TransferByte(USART, DataByte);
}
/** Sends a dummy byte through the USART SPI interface, blocking until the transfer is complete. The response
}
/** Sends a dummy byte through the USART SPI interface, blocking until the transfer is complete. The response
@@
-189,14
+195,12
@@
*
* \return The response byte from the attached SPI device.
*/
*
* \return The response byte from the attached SPI device.
*/
+ static inline uint8_t SerialSPI_ReceiveByte(USART_t* const USART) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
static inline uint8_t SerialSPI_ReceiveByte(USART_t* const USART)
{
static inline uint8_t SerialSPI_ReceiveByte(USART_t* const USART)
{
- USART->DATA = 0;
- while (!(USART->STATUS & USART_TXCIF_bm));
- USART->STATUS = USART_TXCIF_bm;
- return USART->DATA;
+ return SerialSPI_TransferByte(USART, 0);
}
}
-
+
/* Disable C linkage for C++ Compilers: */
#if defined(__cplusplus)
}
/* Disable C linkage for C++ Compilers: */
#if defined(__cplusplus)
}
projects / pub / lufa.git / blobdiff