bissen21/Marlin_Firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

Comments in HAL_spi_STM32F1.cpp

Browse Source
This commit is contained in:
Scott Lahteine 2019-02-11 18:06:15 -06:00
parent 773fa5c40f
commit d9a3fea022
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Marlin/src/HAL/HAL_STM32F1/HAL_spi_STM32F1.cpp
View File

@ -86,7 +86,7 @@ void spiBegin() {
} }
/** /**
* @brief Initializes SPI port to required speed rate and transfer mode (MSB, SPI MODE 0) * @brief Initialize SPI port to required speed rate and transfer mode (MSB, SPI MODE 0)
* *
* @param spiRate Rate as declared in HAL.h (speed do not match AVR) * @param spiRate Rate as declared in HAL.h (speed do not match AVR)
* @return Nothing * @return Nothing
@ -109,7 +109,7 @@ void spiInit(uint8_t spiRate) {
} }
/** /**
* @brief Receives a single byte from the SPI port. * @brief Receive a single byte from the SPI port.
* *
* @return Byte received * @return Byte received
* *
@ -123,7 +123,7 @@ uint8_t spiRec(void) {
} }
/** /**
* @brief Receives a number of bytes from the SPI port to a buffer * @brief Receive a number of bytes from the SPI port to a buffer
* *
* @param buf Pointer to starting address of buffer to write to. * @param buf Pointer to starting address of buffer to write to.
* @param nbyte Number of bytes to receive. * @param nbyte Number of bytes to receive.
@ -138,7 +138,7 @@ void spiRead(uint8_t* buf, uint16_t nbyte) {
} }
/** /**
* @brief Sends a single byte on SPI port * @brief Send a single byte on SPI port
* *
* @param b Byte to send * @param b Byte to send
* *
@ -165,7 +165,16 @@ void spiSendBlock(uint8_t token, const uint8_t* buf) {
SPI.endTransaction(); SPI.endTransaction();
} }
/** Begin SPI transaction, set clock, bit order, data mode */ /**
* @brief Begin SPI transaction, set clock, bit order, data mode
*
* @param spiClock Clock setting
* @param bitOrder Bit Order setting
* @param dataMode Data Mode setting
* @return Nothing
*
* @details Uses an SPI Config via SPISettings
*/
void spiBeginTransaction(uint32_t spiClock, uint8_t bitOrder, uint8_t dataMode) { void spiBeginTransaction(uint32_t spiClock, uint8_t bitOrder, uint8_t dataMode) {
spiConfig = SPISettings(spiClock, (BitOrder)bitOrder, dataMode); spiConfig = SPISettings(spiClock, (BitOrder)bitOrder, dataMode);
SPI.beginTransaction(spiConfig); SPI.beginTransaction(spiConfig);