Skip to content

Commit a117d12

Browse files
ananglkartben
authored andcommitted
include: spi: Restore warning in spi_config structure documentation
It was added in commit 7a8a4c9, but then, presumably unintentionally, was removed in commit 4c4e2c5. Signed-off-by: Andrzej Głąbek <[email protected]>
1 parent e2af9e3 commit a117d12

File tree

1 file changed

+4
-0
lines changed
  • include/zephyr/drivers

1 file changed

+4
-0
lines changed

include/zephyr/drivers/spi.h

+4
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,10 @@ typedef uint16_t spi_operation_t;
297297

298298
/**
299299
* @brief SPI controller configuration structure
300+
*
301+
* @warning Most drivers use pointer comparison to determine whether a passed
302+
* configuration is different from one used in a previous transaction.
303+
* Changes to fields in the structure may not be detected.
300304
*/
301305
struct spi_config {
302306
/** @brief Bus frequency in Hertz. */

0 commit comments

Comments
 (0)