Skip to content

Commit 27dc79a

Browse files
author
Kyle Kearney
committed
QSPI: document use of QSPI_NO_INST
Add comments to functions that can take a qspi_inst_t about the value that will cause the instruction phase to be skipped entirely.
1 parent ea3ead0 commit 27dc79a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

drivers/QSPI.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ class QSPI : private NonCopyable<QSPI> {
151151

152152
/** Read from QSPI peripheral using custom read instruction, alt values
153153
*
154-
* @param instruction Instruction value to be used in instruction phase
154+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
155155
* @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase
156156
* @param address Address to be accessed in QSPI peripheral
157157
* @param rx_buffer Buffer for data to be read from the peripheral
@@ -164,7 +164,7 @@ class QSPI : private NonCopyable<QSPI> {
164164

165165
/** Write to QSPI peripheral using custom write instruction, alt values
166166
*
167-
* @param instruction Instruction value to be used in instruction phase
167+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
168168
* @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase
169169
* @param address Address to be accessed in QSPI peripheral
170170
* @param tx_buffer Buffer containing data to be sent to peripheral
@@ -177,7 +177,7 @@ class QSPI : private NonCopyable<QSPI> {
177177

178178
/** Perform a transaction to write to an address(a control register) and get the status results
179179
*
180-
* @param instruction Instruction value to be used in instruction phase
180+
* @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase
181181
* @param address Some instruction might require address. Use -1 if no address
182182
* @param tx_buffer Buffer containing data to be sent to peripheral
183183
* @param tx_length Pointer to a variable containing the length of data to be transmitted, and on return this variable will be updated with the actual number of bytes written

0 commit comments

Comments
 (0)