You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by xi...@apache.org on 2023/01/26 02:24:15 UTC

[nuttx] 04/05: arch/xtensa/esp32: style fixes in SPI driver

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git

commit c415ce518f273a28178e4b1aa0a5350a21034eab
Author: Petro Karashchenko <pe...@gmail.com>
AuthorDate: Wed Jan 25 23:00:01 2023 +0200

    arch/xtensa/esp32: style fixes in SPI driver
    
    Signed-off-by: Petro Karashchenko <pe...@gmail.com>
---
 arch/xtensa/src/esp32/esp32_spi.c     | 112 ++++++++++++++++++----------------
 arch/xtensa/src/esp32s3/esp32s3_spi.c |  13 ++--
 2 files changed, 65 insertions(+), 60 deletions(-)

diff --git a/arch/xtensa/src/esp32/esp32_spi.c b/arch/xtensa/src/esp32/esp32_spi.c
index 59691b0e97..1edb011ba5 100644
--- a/arch/xtensa/src/esp32/esp32_spi.c
+++ b/arch/xtensa/src/esp32/esp32_spi.c
@@ -295,9 +295,9 @@ static const struct spi_ops_s esp32_spi2_ops =
 static struct esp32_spi_priv_s esp32_spi2_priv =
 {
   .spi_dev =
-  {
-    .ops   = &esp32_spi2_ops
-  },
+    {
+      .ops = &esp32_spi2_ops
+    },
   .config  = &esp32_spi2_config,
   .lock    = NXMUTEX_INITIALIZER,
   .sem_isr = SEM_INITIALIZER(0),
@@ -372,9 +372,9 @@ static const struct spi_ops_s esp32_spi3_ops =
 static struct esp32_spi_priv_s esp32_spi3_priv =
 {
   .spi_dev =
-  {
-    .ops = &esp32_spi3_ops
-  },
+    {
+      .ops = &esp32_spi3_ops
+    },
   .config  = &esp32_spi3_config,
   .lock    = NXMUTEX_INITIALIZER,
   .sem_isr = SEM_INITIALIZER(0),
@@ -563,9 +563,8 @@ static void esp32_spi_select(struct spi_dev_s *dev,
 {
 #ifdef CONFIG_ESP32_SPI_SWCS
   struct esp32_spi_priv_s *priv = (struct esp32_spi_priv_s *)dev;
-  bool value = selected ? false : true;
 
-  esp32_gpiowrite(priv->config->cs_pin, value);
+  esp32_gpiowrite(priv->config->cs_pin, !selected);
 #endif
 
   spiinfo("devid: %08" PRIx32 " CS: %s\n",
@@ -674,11 +673,11 @@ static uint32_t esp32_spi_setfrequency(struct spi_dev_s *dev,
  *   Set the SPI mode.
  *
  * Input Parameters:
- *   dev -  Device-specific state data
- *   mode - The SPI mode requested
+ *   dev  - Device-specific state data
+ *   mode - The requested SPI mode
  *
  * Returned Value:
- *   none
+ *   None.
  *
  ****************************************************************************/
 
@@ -753,14 +752,14 @@ static void esp32_spi_setmode(struct spi_dev_s *dev,
  * Name: esp32_spi_setbits
  *
  * Description:
- *   Set the number if bits per word.
+ *   Set the number of bits per word.
  *
  * Input Parameters:
- *   dev -  Device-specific state data
+ *   dev   - Device-specific state data
  *   nbits - The number of bits in an SPI word.
  *
  * Returned Value:
- *   none
+ *   None.
  *
  ****************************************************************************/
 
@@ -816,7 +815,7 @@ static int esp32_spi_hwfeatures(struct spi_dev_s *dev,
  *              uint16_t's
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -966,11 +965,11 @@ static void esp32_spi_dma_exchange(struct esp32_spi_priv_s *priv,
  *
  * Input Parameters:
  *   priv - SPI private state data
- *   wd  - The word to send.  the size of the data is determined by the
- *         number of bits selected for the SPI interface.
+ *   wd   - The word to send. The size of the data is determined by the
+ *          number of bits selected for the SPI interface.
  *
  * Returned Value:
- *   Received value
+ *   Received value.
  *
  ****************************************************************************/
 
@@ -997,7 +996,7 @@ static uint32_t esp32_spi_poll_send(struct esp32_spi_priv_s *priv,
 
   val = getreg32(spi_w0_reg);
 
-  spiinfo("send=%x and recv=%x\n", wd, val);
+  spiinfo("send=0x%" PRIx32 " and recv=0x%" PRIx32 "\n", wd, val);
 
   return val;
 }
@@ -1010,11 +1009,11 @@ static uint32_t esp32_spi_poll_send(struct esp32_spi_priv_s *priv,
  *
  * Input Parameters:
  *   dev - Device-specific state data
- *   wd  - The word to send.  the size of the data is determined by the
+ *   wd  - The word to send. The size of the data is determined by the
  *         number of bits selected for the SPI interface.
  *
  * Returned Value:
- *   Received value
+ *   Received value.
  *
  ****************************************************************************/
 
@@ -1035,14 +1034,14 @@ static uint32_t esp32_spi_send(struct spi_dev_s *dev, uint32_t wd)
  *   priv     - SPI private state data
  *   txbuffer - A pointer to the buffer of data to be sent
  *   rxbuffer - A pointer to the buffer in which to receive data
- *   nwords   - the length of data that to be exchanged in units of words.
+ *   nwords   - The length of data that to be exchanged in units of words.
  *              The wordsize is determined by the number of bits-per-word
- *              selected for the SPI interface.  If nbits <= 8, the data is
+ *              selected for the SPI interface. If nbits <= 8, the data is
  *              packed into uint8_t's; if nbits >8, the data is packed into
  *              uint16_t's
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -1163,14 +1162,14 @@ static void esp32_spi_poll_exchange(struct esp32_spi_priv_s *priv,
  *   dev      - Device-specific state data
  *   txbuffer - A pointer to the buffer of data to be sent
  *   rxbuffer - A pointer to the buffer in which to receive data
- *   nwords   - the length of data that to be exchanged in units of words.
+ *   nwords   - The length of data that to be exchanged in units of words.
  *              The wordsize is determined by the number of bits-per-word
- *              selected for the SPI interface.  If nbits <= 8, the data is
+ *              selected for the SPI interface. If nbits <= 8, the data is
  *              packed into uint8_t's; if nbits >8, the data is packed into
  *              uint16_t's
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -1206,16 +1205,16 @@ static void esp32_spi_exchange(struct spi_dev_s *dev,
  *   Send a block of data on SPI.
  *
  * Input Parameters:
- *   dev    - Device-specific state data
- *   buffer - A pointer to the buffer of data to be sent
- *   nwords - the length of data to send from the buffer in number of words.
- *            The wordsize is determined by the number of bits-per-word
- *            selected for the SPI interface.  If nbits <= 8, the data is
- *            packed into uint8_t's; if nbits >8, the data is packed into
- *            uint16_t's
+ *   dev      - Device-specific state data
+ *   txbuffer - A pointer to the buffer of data to be sent
+ *   nwords   - The length of data to send from the buffer in number of
+ *              words. The wordsize is determined by the number of
+ *              bits-per-word selected for the SPI interface. If nbits <= 8,
+ *              the data is packed into uint8_t's; if nbits >8, the data is
+ *              packed into uint16_t's
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -1235,16 +1234,16 @@ static void esp32_spi_sndblock(struct spi_dev_s *dev,
  *   Receive a block of data from SPI.
  *
  * Input Parameters:
- *   dev -    Device-specific state data
- *   buffer - A pointer to the buffer in which to receive data
- *   nwords - the length of data that can be received in the buffer in number
- *            of words.  The wordsize is determined by the number of bits-
- *            per-word selected for the SPI interface.  If nbits <= 8, the
- *            data is packed into uint8_t's; if nbits >8, the data is packed
- *            into uint16_t's
+ *   dev      - Device-specific state data
+ *   rxbuffer - A pointer to the buffer in which to receive data
+ *   nwords   - The length of data that can be received in the buffer in
+ *              number of words. The wordsize is determined by the number of
+ *              bits-per-word selected for the SPI interface. If nbits <= 8,
+ *              the data is packed into uint8_t's; if nbits >8, the data is
+ *              packed into uint16_t's
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -1409,7 +1408,7 @@ static void esp32_spi_init(struct spi_dev_s *dev)
  *   dev      - Device-specific state data
  *
  * Returned Value:
- *   None
+ *   None.
  *
  ****************************************************************************/
 
@@ -1436,10 +1435,12 @@ static void esp32_spi_deinit(struct spi_dev_s *dev)
  * Name: esp32_spi_interrupt
  *
  * Description:
- *   Common SPI DMA interrupt handler
+ *   Common SPI DMA interrupt handler.
  *
  * Input Parameters:
- *   arg - SPI controller private data
+ *   irq     - Number of the IRQ that generated the interrupt
+ *   context - Interrupt register state save info
+ *   arg     - SPI controller private data
  *
  * Returned Value:
  *   Standard interrupt return value.
@@ -1460,13 +1461,13 @@ static int esp32_spi_interrupt(int irq, void *context, void *arg)
  * Name: esp32_spibus_initialize
  *
  * Description:
- *   Initialize the selected SPI bus
+ *   Initialize the selected SPI bus.
  *
  * Input Parameters:
- *   Port number (for hardware that has multiple SPI interfaces)
+ *   port     - Port number (for hardware that has multiple SPI interfaces)
  *
  * Returned Value:
- *   Valid SPI device structure reference on success; a NULL on failure
+ *   Valid SPI device structure reference on success; NULL on failure.
  *
  ****************************************************************************/
 
@@ -1492,14 +1493,13 @@ struct spi_dev_s *esp32_spibus_initialize(int port)
         return NULL;
     }
 
-  nxmutex_lock(&priv->lock);
-
   spi_dev = (struct spi_dev_s *)priv;
+
+  nxmutex_lock(&priv->lock);
   if (priv->refs != 0)
     {
       priv->refs++;
       nxmutex_unlock(&priv->lock);
-
       return spi_dev;
     }
 
@@ -1540,7 +1540,13 @@ struct spi_dev_s *esp32_spibus_initialize(int port)
  * Name: esp32_spibus_uninitialize
  *
  * Description:
- *   Uninitialize an SPI bus
+ *   Uninitialize an SPI bus.
+ *
+ * Input Parameters:
+ *   dev      - Device-specific state data
+ *
+ * Returned Value:
+ *   Zero (OK) is returned on success. Otherwise -1 (ERROR).
  *
  ****************************************************************************/
 
diff --git a/arch/xtensa/src/esp32s3/esp32s3_spi.c b/arch/xtensa/src/esp32s3/esp32s3_spi.c
index e99952e9d6..cd9d9dba71 100644
--- a/arch/xtensa/src/esp32s3/esp32s3_spi.c
+++ b/arch/xtensa/src/esp32s3/esp32s3_spi.c
@@ -39,7 +39,6 @@
 #include <nuttx/irq.h>
 #include <nuttx/clock.h>
 #include <nuttx/mutex.h>
-#include <nuttx/semaphore.h>
 #include <nuttx/spi/spi.h>
 
 #include <arch/board/board.h>
@@ -291,9 +290,9 @@ static const struct spi_ops_s esp32s3_spi2_ops =
 static struct esp32s3_spi_priv_s esp32s3_spi2_priv =
 {
   .spi_dev     =
-  {
-    .ops       = &esp32s3_spi2_ops
-  },
+    {
+      .ops     = &esp32s3_spi2_ops
+    },
   .config      = &esp32s3_spi2_config,
   .refs        = 0,
   .lock        = NXMUTEX_INITIALIZER,
@@ -366,9 +365,9 @@ static const struct spi_ops_s esp32s3_spi3_ops =
 static struct esp32s3_spi_priv_s esp32s3_spi3_priv =
 {
   .spi_dev     =
-  {
-    .ops       = &esp32s3_spi3_ops
-  },
+    {
+      .ops     = &esp32s3_spi3_ops
+    },
   .config      = &esp32s3_spi3_config,
   .refs        = 0,
   .lock        = NXMUTEX_INITIALIZER,