From 27dc79af087b66dc83e2247d27f0c3e55724bbee Mon Sep 17 00:00:00 2001 From: Kyle Kearney Date: Tue, 15 Oct 2019 14:57:49 -0700 Subject: [PATCH] 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. --- drivers/QSPI.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/drivers/QSPI.h b/drivers/QSPI.h index 657be507260..8ff8f5e243a 100644 --- a/drivers/QSPI.h +++ b/drivers/QSPI.h @@ -151,7 +151,7 @@ class QSPI : private NonCopyable { /** Read from QSPI peripheral using custom read instruction, alt values * - * @param instruction Instruction value to be used in instruction phase + * @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase * @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase * @param address Address to be accessed in QSPI peripheral * @param rx_buffer Buffer for data to be read from the peripheral @@ -164,7 +164,7 @@ class QSPI : private NonCopyable { /** Write to QSPI peripheral using custom write instruction, alt values * - * @param instruction Instruction value to be used in instruction phase + * @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase * @param alt Alt value to be used in Alternate-byte phase. Use -1 for ignoring Alternate-byte phase * @param address Address to be accessed in QSPI peripheral * @param tx_buffer Buffer containing data to be sent to peripheral @@ -177,7 +177,7 @@ class QSPI : private NonCopyable { /** Perform a transaction to write to an address(a control register) and get the status results * - * @param instruction Instruction value to be used in instruction phase + * @param instruction Instruction value to be used in instruction phase. Use QSPI_NO_INST to skip the instruction phase * @param address Some instruction might require address. Use -1 if no address * @param tx_buffer Buffer containing data to be sent to peripheral * @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