Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-29 20:56:47 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Standardization of some function headers.

Browse Source
This commit is contained in:
Gregory Nutt
2018-03-13 09:52:27 -06:00
parent c268288c17
commit b54ffe858a
488 changed files with 2008 additions and 2007 deletions
Download Patch File Download Diff File Expand all files Collapse all files
arch/arm/src/c5471/c5471_ethernet.c
+19 -19
View File
@@ -870,7 +870,7 @@ static inline void c5471_incrxcpu(struct c5471_driver_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1004,7 +1004,7 @@ static int c5471_transmit(struct c5471_driver_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1075,7 +1075,7 @@ static int c5471_txpoll(struct net_driver_s *dev)
* Description: * Description:
* An interrupt was received indicating that the last RX packet(s) is done * An interrupt was received indicating that the last RX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1177,7 +1177,7 @@ static void c5471_rxstatus(struct c5471_driver_s *priv)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1420,7 +1420,7 @@ static void c5471_receive(struct c5471_driver_s *priv)
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1517,7 +1517,7 @@ static void c5471_txstatus(struct c5471_driver_s *priv)
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1544,7 +1544,7 @@ static void c5471_txdone(struct c5471_driver_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1624,7 +1624,7 @@ static void c5471_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1673,7 +1673,7 @@ static int c5471_interrupt(int irq, FAR void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1714,7 +1714,7 @@ static void c5471_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1750,7 +1750,7 @@ static void c5471_txtimeout_expiry(int argc, wdparm_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1790,7 +1790,7 @@ static void c5471_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1818,7 +1818,7 @@ static void c5471_poll_expiry(int argc, wdparm_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1882,7 +1882,7 @@ static int c5471_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1935,7 +1935,7 @@ static int c5471_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1980,7 +1980,7 @@ static void c5471_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2017,7 +2017,7 @@ static int c5471_txavail(FAR struct net_driver_s *dev)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2047,7 +2047,7 @@ static int c5471_addmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2410,7 +2410,7 @@ static void c5471_macassign(struct c5471_driver_s *priv)
* Description: * Description:
* Initialize the Ethernet driver * Initialize the Ethernet driver
* *
* Parameters: * Input Parameters:
* None * None
* *
* Returned Value: * Returned Value:
arch/arm/src/kinetis/kinetis.h
+1 -1
View File
@@ -582,7 +582,7 @@ void kinetis_pinirqinitialize(void);
* 2. Call kinetis_pinirqattach() to attach the pin interrupt handling function. * 2. Call kinetis_pinirqattach() to attach the pin interrupt handling function.
* 3. Call kinetis_pinirqenable() to enable interrupts on the pin. * 3. Call kinetis_pinirqenable() to enable interrupts on the pin.
* *
* Parameters: * Input Parameters:
* pinset - Pin configuration * pinset - Pin configuration
* pinisr - Pin interrupt service routine * pinisr - Pin interrupt service routine
* arg - An argument that will be provided to the interrupt service routine. * arg - An argument that will be provided to the interrupt service routine.
arch/arm/src/kinetis/kinetis_enet.c
+26 -26
View File
@@ -343,7 +343,7 @@ static void kinetis_reset(struct kinetis_driver_s *priv);
* structures are overlayed on the data, the bytes are reversed because * structures are overlayed on the data, the bytes are reversed because
* the underlying hardware writes the data in big-endian byte order. * the underlying hardware writes the data in big-endian byte order.
* *
* Parameters: * Input Parameters:
* value - The value to be byte swapped * value - The value to be byte swapped
* *
* Returned Value: * Returned Value:
@@ -387,7 +387,7 @@ static inline uint16_t kinesis_swap16(uint16_t value)
* Description: * Description:
* Check if all of the TX descriptors are in use. * Check if all of the TX descriptors are in use.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -421,7 +421,7 @@ static bool kinetis_txringfull(FAR struct kinetis_driver_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -525,7 +525,7 @@ static int kinetis_transmit(FAR struct kinetis_driver_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -600,7 +600,7 @@ static int kinetis_txpoll(struct net_driver_s *dev)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -768,7 +768,7 @@ static void kinetis_receive(FAR struct kinetis_driver_s *priv)
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -827,7 +827,7 @@ static void kinetis_txdone(FAR struct kinetis_driver_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -916,7 +916,7 @@ static void kinetis_interrupt_work(FAR void *arg)
* 2. Ethernet MAC receive interrupt handler * 2. Ethernet MAC receive interrupt handler
* 3. * 3.
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -964,7 +964,7 @@ static int kinetis_interrupt(int irq, FAR void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1004,7 +1004,7 @@ static void kinetis_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1043,7 +1043,7 @@ static void kinetis_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1086,7 +1086,7 @@ static void kinetis_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1114,7 +1114,7 @@ static void kinetis_polltimer_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1246,7 +1246,7 @@ static int kinetis_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1296,7 +1296,7 @@ static int kinetis_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1341,7 +1341,7 @@ static void kinetis_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1379,7 +1379,7 @@ static int kinetis_txavail(struct net_driver_s *dev)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -1409,7 +1409,7 @@ static int kinetis_addmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -1439,7 +1439,7 @@ static int kinetis_rmmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* Description: * Description:
* PHY ioctl command handler * PHY ioctl command handler
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* cmd - ioctl command * cmd - ioctl command
* arg - Argument accompanying the command * arg - Argument accompanying the command
@@ -1504,7 +1504,7 @@ static int kinetis_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Configure the MII interface * Configure the MII interface
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* *
* Returned Value: * Returned Value:
@@ -1531,7 +1531,7 @@ static void kinetis_initmii(struct kinetis_driver_s *priv)
* Description: * Description:
* Write a 16-bit value to a PHY register. * Write a 16-bit value to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* phyaddr - The PHY address * phyaddr - The PHY address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -1590,7 +1590,7 @@ static int kinetis_writemii(struct kinetis_driver_s *priv, uint8_t phyaddr,
* Description: * Description:
* Read a 16-bit value from a PHY register. * Read a 16-bit value from a PHY register.
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* phyaddr - The PHY address * phyaddr - The PHY address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -1653,7 +1653,7 @@ static int kinetis_readmii(struct kinetis_driver_s *priv, uint8_t phyaddr,
* Description: * Description:
* Configure the PHY * Configure the PHY
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* *
* Returned Value: * Returned Value:
@@ -1869,7 +1869,7 @@ static inline int kinetis_initphy(struct kinetis_driver_s *priv)
* Description: * Description:
* Initialize ENET buffers and descriptors * Initialize ENET buffers and descriptors
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* *
* Returned Value: * Returned Value:
@@ -1948,7 +1948,7 @@ static void kinetis_initbuffers(struct kinetis_driver_s *priv)
* Description: * Description:
* Put the EMAC in the non-operational, reset state * Put the EMAC in the non-operational, reset state
* *
* Parameters: * Input Parameters:
* priv - Reference to the private ENET driver state structure * priv - Reference to the private ENET driver state structure
* *
* Returned Value: * Returned Value:
@@ -1984,7 +1984,7 @@ static void kinetis_reset(struct kinetis_driver_s *priv)
* Description: * Description:
* Initialize the Ethernet controller and driver * Initialize the Ethernet controller and driver
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value * intf - In the case where there are multiple EMACs, this value
* identifies which EMAC is to be initialized. * identifies which EMAC is to be initialized.
* *
arch/arm/src/kinetis/kinetis_pinirq.c
+1 -1
View File
@@ -262,7 +262,7 @@ void kinetis_pinirqinitialize(void)
* 2. Call kinetis_pinirqattach() to attach the pin interrupt handling function. * 2. Call kinetis_pinirqattach() to attach the pin interrupt handling function.
* 3. Call kinetis_pinirqenable() to enable interrupts on the pin. * 3. Call kinetis_pinirqenable() to enable interrupts on the pin.
* *
* Parameters: * Input Parameters:
* pinset - Pin configuration * pinset - Pin configuration
* pinisr - Pin interrupt service routine * pinisr - Pin interrupt service routine
* arg - An argument that will be provided to the interrupt service routine. * arg - An argument that will be provided to the interrupt service routine.
arch/arm/src/kl/kl_gpio.h
+1 -1
View File
@@ -365,7 +365,7 @@ bool kl_gpioread(uint32_t pinset);
* 2. Call kl_gpioirqattach() to attach the pin interrupt handling function. * 2. Call kl_gpioirqattach() to attach the pin interrupt handling function.
* 3. Call kl_gpioirqenable() to enable interrupts on the pin. * 3. Call kl_gpioirqenable() to enable interrupts on the pin.
* *
* Parameters: * Input Parameters:
* - pinset: Pin configuration * - pinset: Pin configuration
* - pinisr: Pin interrupt service routine * - pinisr: Pin interrupt service routine
* - pinarg: The argument that will accompany the pin interrupt * - pinarg: The argument that will accompany the pin interrupt
arch/arm/src/kl/kl_gpioirq.c
+1 -1
View File
@@ -225,7 +225,7 @@ void kl_gpioirqinitialize(void)
* 2. Call kl_gpioirqattach() to attach the pin interrupt handling function. * 2. Call kl_gpioirqattach() to attach the pin interrupt handling function.
* 3. Call kl_gpioirqenable() to enable interrupts on the pin. * 3. Call kl_gpioirqenable() to enable interrupts on the pin.
* *
* Parameters: * Input Parameters:
* - pinset: Pin configuration * - pinset: Pin configuration
* - pinisr: Pin interrupt service routine * - pinisr: Pin interrupt service routine
* - pinarg: The argument that will accompany the pin interrupt * - pinarg: The argument that will accompany the pin interrupt
arch/arm/src/lpc17xx/lpc17_ethernet.c
+32 -32
View File
@@ -533,7 +533,7 @@ static void lpc17_putreg(uint32_t val, uint32_t addr)
* Description: * Description:
* Check if a free TX descriptor is available. * Check if a free TX descriptor is available.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -576,7 +576,7 @@ static int lpc17_txdesc(struct lpc17_driver_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -670,7 +670,7 @@ static int lpc17_transmit(struct lpc17_driver_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -749,7 +749,7 @@ static int lpc17_txpoll(struct net_driver_s *dev)
* (2) hold the outgoing packet in a pending state until the next Tx * (2) hold the outgoing packet in a pending state until the next Tx
* interrupt occurs. * interrupt occurs.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -794,7 +794,7 @@ static void lpc17_response(struct lpc17_driver_s *priv)
* Perform Rx interrupt handling logic outside of the interrupt handler (on * Perform Rx interrupt handling logic outside of the interrupt handler (on
* the work queue thread). * the work queue thread).
* *
* Parameters: * Input Parameters:
* arg - The reference to the driver structure (case to void*) * arg - The reference to the driver structure (case to void*)
* *
* Returned Value: * Returned Value:
@@ -1060,7 +1060,7 @@ static void lpc17_rxdone_work(FAR void *arg)
* Perform Tx interrupt handling logic outside of the interrupt handler (on * Perform Tx interrupt handling logic outside of the interrupt handler (on
* the work queue thread). * the work queue thread).
* *
* Parameters: * Input Parameters:
* arg - The reference to the driver structure (case to void*) * arg - The reference to the driver structure (case to void*)
* *
* Returned Value: * Returned Value:
@@ -1112,7 +1112,7 @@ static void lpc17_txdone_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1310,7 +1310,7 @@ static int lpc17_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1352,7 +1352,7 @@ static void lpc17_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1393,7 +1393,7 @@ static void lpc17_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1453,7 +1453,7 @@ static void lpc17_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1482,7 +1482,7 @@ static void lpc17_poll_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -1556,7 +1556,7 @@ static void lpc17_ipv6multicast(FAR struct lpc17_driver_s *priv)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1731,7 +1731,7 @@ static int lpc17_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1770,7 +1770,7 @@ static int lpc17_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1811,7 +1811,7 @@ static void lpc17_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1861,7 +1861,7 @@ static int lpc17_txavail(struct net_driver_s *dev)
* warranty that such application will be suitable for the specified * warranty that such application will be suitable for the specified
* use without further testing or modification. * use without further testing or modification.
* *
* Parameters: * Input Parameters:
* data - the data to be checked * data - the data to be checked
* length - length of the data * length - length of the data
* *
@@ -1942,7 +1942,7 @@ static uint32_t lpc17_calcethcrc(const uint8_t *data, size_t length)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2017,7 +2017,7 @@ static int lpc17_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2098,7 +2098,7 @@ static int lpc17_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* Description: * Description:
* Dump GPIO registers * Dump GPIO registers
* *
* Parameters: * Input Parameters:
* None * None
* *
* Returned Value: * Returned Value:
@@ -2122,7 +2122,7 @@ static void lpc17_showpins(void)
* Description: * Description:
* Dump PHY MII registers * Dump PHY MII registers
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* *
* Returned Value: * Returned Value:
@@ -2153,7 +2153,7 @@ static void lpc17_showmii(uint8_t phyaddr, const char *msg)
* Description: * Description:
* Write a value to an MII PHY register * Write a value to an MII PHY register
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* regaddr - The address of the PHY register to be written * regaddr - The address of the PHY register to be written
* phydata - The data to write to the PHY register * phydata - The data to write to the PHY register
@@ -2196,7 +2196,7 @@ static void lpc17_phywrite(uint8_t phyaddr, uint8_t regaddr, uint16_t phydata)
* Description: * Description:
* Read a value from an MII PHY register * Read a value from an MII PHY register
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* regaddr - The address of the PHY register to be written * regaddr - The address of the PHY register to be written
* *
@@ -2241,7 +2241,7 @@ static uint16_t lpc17_phyread(uint8_t phyaddr, uint8_t regaddr)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* *
* Returned Value: * Returned Value:
@@ -2289,7 +2289,7 @@ static inline int lpc17_phyreset(uint8_t phyaddr)
* Description: * Description:
* Enable auto-negotiation. * Enable auto-negotiation.
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* *
* Returned Value: * Returned Value:
@@ -2336,7 +2336,7 @@ static inline int lpc17_phyautoneg(uint8_t phyaddr)
* Description: * Description:
* Set the PHY to operate at a selected speed/duplex mode. * Set the PHY to operate at a selected speed/duplex mode.
* *
* Parameters: * Input Parameters:
* phyaddr - The device address where the PHY was discovered * phyaddr - The device address where the PHY was discovered
* mode - speed/duplex mode * mode - speed/duplex mode
* *
@@ -2420,7 +2420,7 @@ static int lpc17_phymode(uint8_t phyaddr, uint8_t mode)
* Description: * Description:
* Initialize the PHY * Initialize the PHY
* *
* Parameters: * Input Parameters:
* priv - Pointer to EMAC device driver structure * priv - Pointer to EMAC device driver structure
* *
* Returned Value: * Returned Value:
@@ -2720,7 +2720,7 @@ static inline int lpc17_phyinit(struct lpc17_driver_s *priv)
* Description: * Description:
* Initialize the EMAC Tx descriptor table * Initialize the EMAC Tx descriptor table
* *
* Parameters: * Input Parameters:
* priv - Pointer to EMAC device driver structure * priv - Pointer to EMAC device driver structure
* *
* Returned Value: * Returned Value:
@@ -2776,7 +2776,7 @@ static inline void lpc17_txdescinit(struct lpc17_driver_s *priv)
* Description: * Description:
* Initialize the EMAC Rx descriptor table * Initialize the EMAC Rx descriptor table
* *
* Parameters: * Input Parameters:
* priv - Pointer to EMAC device driver structure * priv - Pointer to EMAC device driver structure
* *
* Returned Value: * Returned Value:
@@ -2833,7 +2833,7 @@ static inline void lpc17_rxdescinit(struct lpc17_driver_s *priv)
* Description: * Description:
* Set the MAC to operate at a selected speed/duplex mode. * Set the MAC to operate at a selected speed/duplex mode.
* *
* Parameters: * Input Parameters:
* mode - speed/duplex mode * mode - speed/duplex mode
* *
* Returned Value: * Returned Value:
@@ -2914,7 +2914,7 @@ static void lpc17_macmode(uint8_t mode)
* Description: * Description:
* Configure and reset the Ethernet module, leaving it in a disabled state. * Configure and reset the Ethernet module, leaving it in a disabled state.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2993,7 +2993,7 @@ static void lpc17_ethreset(struct lpc17_driver_s *priv)
* Description: * Description:
* Initialize one Ethernet controller and driver structure. * Initialize one Ethernet controller and driver structure.
* *
* Parameters: * Input Parameters:
* intf - Selects the interface to be initialized. * intf - Selects the interface to be initialized.
* *
* Returned Value: * Returned Value:
arch/arm/src/lpc43xx/lpc43_ethernet.c
+43 -43
View File
@@ -791,7 +791,7 @@ static void lpc43_checksetup(void)
* Description: * Description:
* Initialize the free buffer list. * Initialize the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -828,7 +828,7 @@ static void lpc43_initbuffer(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Allocate one buffer from the free buffer list. * Allocate one buffer from the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -854,7 +854,7 @@ static inline uint8_t *lpc43_allocbuffer(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Return a buffer to the free buffer list. * Return a buffer to the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* buffer - A pointer to the buffer to be freed * buffer - A pointer to the buffer to be freed
* *
@@ -881,7 +881,7 @@ static inline void lpc43_freebuffer(FAR struct lpc43_ethmac_s *priv, uint8_t *bu
* Description: * Description:
* Return TRUE if the free buffer list is not empty. * Return TRUE if the free buffer list is not empty.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -907,7 +907,7 @@ static inline bool lpc43_isfreebuffer(FAR struct lpc43_ethmac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1118,7 +1118,7 @@ static int lpc43_transmit(FAR struct lpc43_ethmac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1225,7 +1225,7 @@ static int lpc43_txpoll(struct net_driver_s *dev)
* 3. After a TX timeout to restart the sending process * 3. After a TX timeout to restart the sending process
* (lpc43_txtimeout_process). * (lpc43_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1286,7 +1286,7 @@ static void lpc43_dopoll(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Enable a "normal" interrupt * Enable a "normal" interrupt
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1314,7 +1314,7 @@ static void lpc43_enableint(FAR struct lpc43_ethmac_s *priv, uint32_t ierbit)
* Description: * Description:
* Disable a normal interrupt. * Disable a normal interrupt.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1353,7 +1353,7 @@ static void lpc43_disableint(FAR struct lpc43_ethmac_s *priv, uint32_t ierbit)
* The function is called when a frame is received using the DMA receive * The function is called when a frame is received using the DMA receive
* interrupt. It scans the RX descriptors to the received frame. * interrupt. It scans the RX descriptors to the received frame.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1409,7 +1409,7 @@ static void lpc43_freesegment(FAR struct lpc43_ethmac_s *priv,
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1572,7 +1572,7 @@ static int lpc43_recvframe(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1749,7 +1749,7 @@ static void lpc43_receive(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Scans the TX descriptors and frees the buffers of completed TX transfers. * Scans the TX descriptors and frees the buffers of completed TX transfers.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1845,7 +1845,7 @@ static void lpc43_freeframe(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1888,7 +1888,7 @@ static void lpc43_txdone(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1991,7 +1991,7 @@ static void lpc43_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -2045,7 +2045,7 @@ static int lpc43_interrupt(int irq, FAR void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2081,7 +2081,7 @@ static void lpc43_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2121,7 +2121,7 @@ static void lpc43_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2193,7 +2193,7 @@ static void lpc43_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2221,7 +2221,7 @@ static void lpc43_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2276,7 +2276,7 @@ static int lpc43_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2323,7 +2323,7 @@ static int lpc43_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2360,7 +2360,7 @@ static void lpc43_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2396,7 +2396,7 @@ static int lpc43_txavail(struct net_driver_s *dev)
* Description: * Description:
* Function to calculate the CRC used by LPC43 to check an Ethernet frame * Function to calculate the CRC used by LPC43 to check an Ethernet frame
* *
* Parameters: * Input Parameters:
* data - the data to be checked * data - the data to be checked
* length - length of the data * length - length of the data
* *
@@ -2441,7 +2441,7 @@ static uint32_t lpc43_calcethcrc(const uint8_t *data, size_t length)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2498,7 +2498,7 @@ static int lpc43_addmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2560,7 +2560,7 @@ static int lpc43_rmmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* Description: * Description:
* Initializes the DMA TX descriptors in chain mode. * Initializes the DMA TX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2642,7 +2642,7 @@ static void lpc43_txdescinit(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Initializes the DMA RX descriptors in chain mode. * Initializes the DMA RX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2733,7 +2733,7 @@ static void lpc43_rxdescinit(FAR struct lpc43_ethmac_s *priv)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2815,7 +2815,7 @@ static int lpc43_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2837,7 +2837,7 @@ static int lpc43_phyintenable(struct lpc43_ethmac_s *priv)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The location to return the 16-bit PHY register value. * value - The location to return the 16-bit PHY register value.
@@ -2892,7 +2892,7 @@ static int lpc43_phyread(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t *val
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The 16-bit value to write to the PHY register value. * value - The 16-bit value to write to the PHY register value.
@@ -2955,7 +2955,7 @@ static int lpc43_phywrite(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t val
* fundamental issue with the PHY clocking initialization, but the * fundamental issue with the PHY clocking initialization, but the
* root cause has not been studied (nor will it be with this workaround). * root cause has not been studied (nor will it be with this workaround).
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3017,7 +3017,7 @@ static inline int lpc43_dm9161(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3314,7 +3314,7 @@ static inline void lpc43_selectrmii(void)
* Description: * Description:
* Configure GPIOs for the Ethernet interface. * Configure GPIOs for the Ethernet interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3403,7 +3403,7 @@ static inline void lpc43_ethgpioconfig(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Reset the Ethernet block. * Reset the Ethernet block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3440,7 +3440,7 @@ static void lpc43_ethreset(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet MAC for DMA operation. * Configure the Ethernet MAC for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3523,7 +3523,7 @@ static int lpc43_macconfig(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3565,7 +3565,7 @@ static void lpc43_macaddress(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3638,7 +3638,7 @@ static void lpc43_ipv6multicast(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Enable normal MAC operation. * Enable normal MAC operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3725,7 +3725,7 @@ static int lpc43_macenable(FAR struct lpc43_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet interface for DMA operation. * Configure the Ethernet interface for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3865,7 +3865,7 @@ static inline int lpc43_ethinitialize(void)
* This is the "standard" network initialization logic called from the * This is the "standard" network initialization logic called from the
* low-level initialization logic in up_initialize.c. * low-level initialization logic in up_initialize.c.
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
arch/arm/src/lpc43xx/lpc43_ethernet.h
+1 -1
View File
@@ -71,7 +71,7 @@ extern "C"
* logic must provide lpc43_phyinitialize(); The LPC43 Ethernet driver will call * logic must provide lpc43_phyinitialize(); The LPC43 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/lpc54xx/lpc54_ethernet.c
+38 -38
View File
@@ -563,7 +563,7 @@ static void lpc54_putreg(uint32_t val, uintptr_t addr)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - The channel to send the packet on * chan - The channel to send the packet on
* *
@@ -696,7 +696,7 @@ static int lpc54_eth_transmit(struct lpc54_ethdriver_s *priv,
* 8021QVLAN AVB packets (and CONFIG_LPC54_ETH_MULTIQUEUE not selected): * 8021QVLAN AVB packets (and CONFIG_LPC54_ETH_MULTIQUEUE not selected):
* Always send on ring 1 * Always send on ring 1
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -738,7 +738,7 @@ static unsigned int lpc54_eth_getring(struct lpc54_ethdriver_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -852,7 +852,7 @@ static int lpc54_eth_txpoll(struct net_driver_s *dev)
* may return return with an outgoing packet. This function checks for * may return return with an outgoing packet. This function checks for
* that case and performs the transmission if necessary. * that case and performs the transmission if necessary.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -922,7 +922,7 @@ static void lpc54_eth_reply(struct lpc54_ethdriver_s *priv)
* A new packet has been received and will be forwarded to the network * A new packet has been received and will be forwarded to the network
* stack. * stack.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1046,7 +1046,7 @@ static void lpc54_eth_rxdispatch(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - The channel with the completed Rx transfer * chan - The channel with the completed Rx transfer
* *
@@ -1234,7 +1234,7 @@ static int lpc54_eth_receive(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - The channel with the completed Tx transfer * chan - The channel with the completed Tx transfer
* *
@@ -1321,7 +1321,7 @@ static void lpc54_eth_txdone(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Perform interrupt related work for a channel DMA interrupt * Perform interrupt related work for a channel DMA interrupt
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - The channel that received the interrupt event. * chan - The channel that received the interrupt event.
* *
@@ -1460,7 +1460,7 @@ static void lpc54_eth_channel_work(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1508,7 +1508,7 @@ static void lpc54_eth_interrupt_work(void *arg)
* Description: * Description:
* Ethernet interrupt handler * Ethernet interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1548,7 +1548,7 @@ static int lpc54_eth_interrupt(int irq, void *context, void *arg)
* Description: * Description:
* Ethernet power management interrupt handler * Ethernet power management interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1571,7 +1571,7 @@ static int lpc54_pmt_interrupt(int irq, void *context, void *arg)
* Description: * Description:
* Ethernet MAC interrupt handler * Ethernet MAC interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1594,7 +1594,7 @@ static int lpc54_mac_interrupt(int irq, void *context, void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1641,7 +1641,7 @@ static void lpc54_eth_txtimeout_work(void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1678,7 +1678,7 @@ static void lpc54_eth_txtimeout_expiry(int argc, wdparm_t arg, ...)
* Check if there are Tx descriptors available and, if so, allocate a Tx * Check if there are Tx descriptors available and, if so, allocate a Tx
* then perform the normal Tx poll * then perform the normal Tx poll
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1745,7 +1745,7 @@ static void lpc54_eth_dotimer(struct lpc54_ethdriver_s *priv)
* Check if there are Tx descriptors available and, if so, allocate a Tx * Check if there are Tx descriptors available and, if so, allocate a Tx
* then perform the normal Tx poll * then perform the normal Tx poll
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1811,7 +1811,7 @@ static void lpc54_eth_dopoll(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1851,7 +1851,7 @@ static void lpc54_eth_poll_work(void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1880,7 +1880,7 @@ static void lpc54_eth_poll_expiry(int argc, wdparm_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2164,7 +2164,7 @@ static int lpc54_eth_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2240,7 +2240,7 @@ static int lpc54_eth_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2283,7 +2283,7 @@ static void lpc54_eth_txavail_work(void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2320,7 +2320,7 @@ static int lpc54_eth_txavail(struct net_driver_s *dev)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2348,7 +2348,7 @@ static int lpc54_eth_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2375,7 +2375,7 @@ static int lpc54_eth_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* Description: * Description:
* Handle network IOCTL commands directed to this device. * Handle network IOCTL commands directed to this device.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* cmd - The IOCTL command * cmd - The IOCTL command
* arg - The argument for the IOCTL command * arg - The argument for the IOCTL command
@@ -2443,7 +2443,7 @@ static int lpc54_eth_ioctl(struct net_driver_s *dev, int cmd,
* Initialize packet buffers my placing all of the pre-allocated packet * Initialize packet buffers my placing all of the pre-allocated packet
* buffers into a free list. * buffers into a free list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2470,7 +2470,7 @@ static void lpc54_pktbuf_initialize(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* Allocate one packet buffer by removing it from the free list. * Allocate one packet buffer by removing it from the free list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2494,7 +2494,7 @@ static inline uint32_t *lpc54_pktbuf_alloc(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* Allocate one packet buffer by removing it from the free list. * Allocate one packet buffer by removing it from the free list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* pktbuf - The packet buffer to be freed * pktbuf - The packet buffer to be freed
* *
@@ -2519,7 +2519,7 @@ static inline void lpc54_pktbuf_free(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Initialize one Tx descriptor ring. * Initialize one Tx descriptor ring.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - Channel being initialized * chan - Channel being initialized
* *
@@ -2569,7 +2569,7 @@ static void lpc54_txring_initialize(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Initialize one Rx descriptor ring. * Initialize one Rx descriptor ring.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* chan - Channel being initialized * chan - Channel being initialized
* *
@@ -2646,7 +2646,7 @@ static void lpc54_rxring_initialize(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Initialize the Rx and Tx rings for every channel. * Initialize the Rx and Tx rings for every channel.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2701,7 +2701,7 @@ static void lpc54_ring_initialize(struct lpc54_ethdriver_s *priv)
* Set the CSR clock divider. The MDC clock derives from the divided down * Set the CSR clock divider. The MDC clock derives from the divided down
* CSR clock (aka core clock or main clock). * CSR clock (aka core clock or main clock).
* *
* Parameters: * Input Parameters:
* None * None
* *
* Returned Value: * Returned Value:
@@ -2743,7 +2743,7 @@ static void lpc54_set_csrdiv(void)
* Description: * Description:
* Read the content from one PHY register. * Read the content from one PHY register.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* phyreg - The 5-bit PHY address to read * phyreg - The 5-bit PHY address to read
* *
@@ -2785,7 +2785,7 @@ static uint16_t lpc54_phy_read(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Write a new value to of one PHY register. * Write a new value to of one PHY register.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* phyreg - The 5-bit PHY address to write * phyreg - The 5-bit PHY address to write
* phyval - The 16-bit value to write to the PHY register * phyval - The 16-bit value to write to the PHY register
@@ -2830,7 +2830,7 @@ static void lpc54_phy_write(struct lpc54_ethdriver_s *priv,
* Description: * Description:
* Read the MII status register and return tru if the link is up. * Read the MII status register and return tru if the link is up.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2851,7 +2851,7 @@ static inline bool lpc54_phy_linkstatus(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* Initialize the PHY. * Initialize the PHY.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2930,7 +2930,7 @@ static int lpc54_phy_autonegotiate(struct lpc54_ethdriver_s *priv)
* Description: * Description:
* Reset the PHY and bring it to the operational status * Reset the PHY and bring it to the operational status
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2992,7 +2992,7 @@ static int lpc54_phy_reset(struct lpc54_ethdriver_s *priv)
* This is the "standard" network initialization logic called from the * This is the "standard" network initialization logic called from the
* low-level initialization logic in up_initialize.c. * low-level initialization logic in up_initialize.c.
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value * intf - In the case where there are multiple EMACs, this value
* identifies which EMAC is to be initialized. * identifies which EMAC is to be initialized.
* *
arch/arm/src/sam34/sam_emac.c
+36 -36
View File
@@ -729,7 +729,7 @@ static void sam_buffer_free(struct sam_emac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -844,7 +844,7 @@ static int sam_transmit(struct sam_emac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -926,7 +926,7 @@ static int sam_txpoll(struct net_driver_s *dev)
* 3. After a TX timeout to restart the sending process * 3. After a TX timeout to restart the sending process
* (sam_txtimeout_process). * (sam_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -962,7 +962,7 @@ static void sam_dopoll(struct sam_emac_s *priv)
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1174,7 +1174,7 @@ static int sam_recvframe(struct sam_emac_s *priv)
* An interrupt was received indicating the availability of one or more * An interrupt was received indicating the availability of one or more
* new RX packets in FIFO memory. * new RX packets in FIFO memory.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1325,7 +1325,7 @@ static void sam_receive(struct sam_emac_s *priv)
* An interrupt was received indicating that one or more frames have * An interrupt was received indicating that one or more frames have
* completed transmission. * completed transmission.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1410,7 +1410,7 @@ static void sam_txdone(struct sam_emac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1604,7 +1604,7 @@ static void sam_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1659,7 +1659,7 @@ static int sam_emac_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1697,7 +1697,7 @@ static void sam_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1731,7 +1731,7 @@ static void sam_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1771,7 +1771,7 @@ static void sam_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1799,7 +1799,7 @@ static void sam_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the EMAC interface when an IP address is * NuttX Callback: Bring up the EMAC interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1875,7 +1875,7 @@ static int sam_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1922,7 +1922,7 @@ static int sam_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1960,7 +1960,7 @@ static void sam_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2126,7 +2126,7 @@ static unsigned int sam_hashindx(const uint8_t *mac)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2199,7 +2199,7 @@ static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2298,7 +2298,7 @@ static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2400,7 +2400,7 @@ static int sam_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Dump the contents of PHY registers * Dump the contents of PHY registers
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2456,7 +2456,7 @@ static void sam_phydump(struct sam_emac_s *priv)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2508,7 +2508,7 @@ static int sam_phyintenable(struct sam_emac_s *priv)
* Description: * Description:
* Wait for the PHY to become IDLE * Wait for the PHY to become IDLE
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2541,7 +2541,7 @@ static int sam_phywait(struct sam_emac_s *priv)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2607,7 +2607,7 @@ static int sam_phyreset(struct sam_emac_s *priv)
* Description: * Description:
* Verify the PHY address and, if it is bad, try to one that works. * Verify the PHY address and, if it is bad, try to one that works.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2690,7 +2690,7 @@ static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2754,7 +2754,7 @@ static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2815,7 +2815,7 @@ static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Autonegotiate speed and duplex. * Autonegotiate speed and duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3039,7 +3039,7 @@ errout:
* Description: * Description:
* Check if the link is up * Check if the link is up
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3136,7 +3136,7 @@ errout:
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3192,7 +3192,7 @@ static int sam_phyinit(struct sam_emac_s *priv)
* Description: * Description:
* Configure GPIOs for the EMAC MII interface. * Configure GPIOs for the EMAC MII interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3232,7 +3232,7 @@ static inline void sam_ethgpioconfig(struct sam_emac_s *priv)
* Description: * Description:
* Reset the transmit logic * Reset the transmit logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3287,7 +3287,7 @@ static void sam_txreset(struct sam_emac_s *priv)
* Description: * Description:
* Reset the receive logic * Reset the receive logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3342,7 +3342,7 @@ static void sam_rxreset(struct sam_emac_s *priv)
* Description: * Description:
* Reset the EMAC block. * Reset the EMAC block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3403,7 +3403,7 @@ static void sam_emac_reset(struct sam_emac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3443,7 +3443,7 @@ static void sam_macaddress(struct sam_emac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3516,7 +3516,7 @@ static void sam_ipv6multicast(struct sam_emac_s *priv)
* Description: * Description:
* Configure the EMAC interface for normal operation. * Configure the EMAC interface for normal operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
arch/arm/src/sam34/sam_emac.h
+1 -1
View File
@@ -99,7 +99,7 @@ void up_netinitialize(void);
* logic must provide sam_phyinitialize(); The SAM34 Ethernet driver will call * logic must provide sam_phyinitialize(); The SAM34 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/sama5/sam_emaca.c
+36 -36
View File
@@ -733,7 +733,7 @@ static void sam_buffer_free(struct sam_emac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -853,7 +853,7 @@ static int sam_transmit(struct sam_emac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -934,7 +934,7 @@ static int sam_txpoll(struct net_driver_s *dev)
* 2. When new TX data is available (sam_txavail), and * 2. When new TX data is available (sam_txavail), and
* 3. After a TX timeout to restart the sending process (sam_txtimeout_expiry). * 3. After a TX timeout to restart the sending process (sam_txtimeout_expiry).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -970,7 +970,7 @@ static void sam_dopoll(struct sam_emac_s *priv)
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1212,7 +1212,7 @@ static int sam_recvframe(struct sam_emac_s *priv)
* An interrupt was received indicating the availability of one or more * An interrupt was received indicating the availability of one or more
* new RX packets in FIFO memory. * new RX packets in FIFO memory.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1363,7 +1363,7 @@ static void sam_receive(struct sam_emac_s *priv)
* An interrupt was received indicating that one or more frames have * An interrupt was received indicating that one or more frames have
* completed transmission. * completed transmission.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1450,7 +1450,7 @@ static void sam_txdone(struct sam_emac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1643,7 +1643,7 @@ static void sam_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1697,7 +1697,7 @@ static int sam_emac_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1733,7 +1733,7 @@ static void sam_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1767,7 +1767,7 @@ static void sam_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1807,7 +1807,7 @@ static void sam_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1835,7 +1835,7 @@ static void sam_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the EMAC interface when an IP address is * NuttX Callback: Bring up the EMAC interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1911,7 +1911,7 @@ static int sam_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1958,7 +1958,7 @@ static int sam_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1996,7 +1996,7 @@ static void sam_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2162,7 +2162,7 @@ static unsigned int sam_hashindx(const uint8_t *mac)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2235,7 +2235,7 @@ static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2334,7 +2334,7 @@ static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2436,7 +2436,7 @@ static int sam_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Dump the contents of PHY registers * Dump the contents of PHY registers
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2492,7 +2492,7 @@ static void sam_phydump(struct sam_emac_s *priv)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2544,7 +2544,7 @@ static int sam_phyintenable(struct sam_emac_s *priv)
* Description: * Description:
* Wait for the PHY to become IDLE * Wait for the PHY to become IDLE
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2577,7 +2577,7 @@ static int sam_phywait(struct sam_emac_s *priv)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2643,7 +2643,7 @@ static int sam_phyreset(struct sam_emac_s *priv)
* Description: * Description:
* Verify the PHY address and, if it is bad, try to one that works. * Verify the PHY address and, if it is bad, try to one that works.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2726,7 +2726,7 @@ static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2781,7 +2781,7 @@ static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2833,7 +2833,7 @@ static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Autonegotiate speed and duplex. * Autonegotiate speed and duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3061,7 +3061,7 @@ errout:
* Description: * Description:
* Check if the link is up * Check if the link is up
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3158,7 +3158,7 @@ errout:
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3226,7 +3226,7 @@ static int sam_phyinit(struct sam_emac_s *priv)
* Description: * Description:
* Configure PIOs for the EMAC interface. * Configure PIOs for the EMAC interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3259,7 +3259,7 @@ static inline void sam_ethgpioconfig(struct sam_emac_s *priv)
* Description: * Description:
* Reset the transmit logic * Reset the transmit logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3323,7 +3323,7 @@ static void sam_txreset(struct sam_emac_s *priv)
* Description: * Description:
* Reset the receive logic * Reset the receive logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3387,7 +3387,7 @@ static void sam_rxreset(struct sam_emac_s *priv)
* Description: * Description:
* Reset the EMAC block. * Reset the EMAC block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3445,7 +3445,7 @@ static void sam_emac_reset(struct sam_emac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3485,7 +3485,7 @@ static void sam_macaddress(struct sam_emac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3558,7 +3558,7 @@ static void sam_ipv6multicast(struct sam_emac_s *priv)
* Description: * Description:
* Configure the EMAC interface for normal operation. * Configure the EMAC interface for normal operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
arch/arm/src/sama5/sam_emacb.c
+39 -39
View File
@@ -1068,7 +1068,7 @@ static void sam_buffer_free(struct sam_emac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1188,7 +1188,7 @@ static int sam_transmit(struct sam_emac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1270,7 +1270,7 @@ static int sam_txpoll(struct net_driver_s *dev)
* 3. After a TX timeout to restart the sending process * 3. After a TX timeout to restart the sending process
* (sam_txtimeout_process). * (sam_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1306,7 +1306,7 @@ static void sam_dopoll(struct sam_emac_s *priv)
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1547,7 +1547,7 @@ static int sam_recvframe(struct sam_emac_s *priv)
* An interrupt was received indicating the availability of one or more * An interrupt was received indicating the availability of one or more
* new RX packets in FIFO memory. * new RX packets in FIFO memory.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1698,7 +1698,7 @@ static void sam_receive(struct sam_emac_s *priv)
* An interrupt was received indicating that one or more frames have * An interrupt was received indicating that one or more frames have
* completed transmission. * completed transmission.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1809,7 +1809,7 @@ static void sam_txdone(struct sam_emac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -2003,7 +2003,7 @@ static void sam_interrupt_work(FAR void *arg)
* Description: * Description:
* Common hardware interrupt handler * Common hardware interrupt handler
* *
* Parameters: * Input Parameters:
* Standard interrupt handler inputs * Standard interrupt handler inputs
* *
* Returned Value: * Returned Value:
@@ -2058,7 +2058,7 @@ static int sam_emac_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2094,7 +2094,7 @@ static void sam_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2128,7 +2128,7 @@ static void sam_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2168,7 +2168,7 @@ static void sam_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2196,7 +2196,7 @@ static void sam_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the EMAC interface when an IP address is * NuttX Callback: Bring up the EMAC interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2280,7 +2280,7 @@ static int sam_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2327,7 +2327,7 @@ static int sam_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2365,7 +2365,7 @@ static void sam_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2531,7 +2531,7 @@ static unsigned int sam_hashindx(const uint8_t *mac)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2603,7 +2603,7 @@ static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2701,7 +2701,7 @@ static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2803,7 +2803,7 @@ static int sam_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Dump the contents of PHY registers * Dump the contents of PHY registers
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2851,7 +2851,7 @@ static void sam_phydump(struct sam_emac_s *priv)
* Description: * Description:
* Helpers to simplify decoding PHY status register bits * Helpers to simplify decoding PHY status register bits
* *
* Parameters: * Input Parameters:
* physr - The value of the PHY status register * physr - The value of the PHY status register
* *
* Returned Value: * Returned Value:
@@ -2949,7 +2949,7 @@ static bool sam_is100fdx(struct sam_emac_s *priv, uint16_t physr)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3009,7 +3009,7 @@ static int sam_phyintenable(struct sam_emac_s *priv)
* Description: * Description:
* Wait for the PHY to become IDLE * Wait for the PHY to become IDLE
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3042,7 +3042,7 @@ static int sam_phywait(struct sam_emac_s *priv)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3108,7 +3108,7 @@ static int sam_phyreset(struct sam_emac_s *priv)
* Description: * Description:
* Verify the PHY address and, if it is bad, try to one that works. * Verify the PHY address and, if it is bad, try to one that works.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3191,7 +3191,7 @@ static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -3256,7 +3256,7 @@ static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -3318,7 +3318,7 @@ static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Autonegotiate speed and duplex. * Autonegotiate speed and duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3547,7 +3547,7 @@ errout:
* Description: * Description:
* Check if the link is up * Check if the link is up
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3644,7 +3644,7 @@ errout:
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3727,7 +3727,7 @@ static int sam_phyinit(struct sam_emac_s *priv)
* MDC Management Data Clock MDC MDC * MDC Management Data Clock MDC MDC
* MDIO Management Data Input/Output MDIO MDIO * MDIO Management Data Input/Output MDIO MDIO
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3819,7 +3819,7 @@ static inline void sam_ethgpioconfig(struct sam_emac_s *priv)
* Description: * Description:
* Reset the transmit logic * Reset the transmit logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3883,7 +3883,7 @@ static void sam_txreset(struct sam_emac_s *priv)
* Description: * Description:
* Reset the receive logic * Reset the receive logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3947,7 +3947,7 @@ static void sam_rxreset(struct sam_emac_s *priv)
* Description: * Description:
* Enable clocking to the EMAC block * Enable clocking to the EMAC block
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3989,7 +3989,7 @@ static void sam_emac_enableclk(struct sam_emac_s *priv)
* Description: * Description:
* Disable clocking to the EMAC block * Disable clocking to the EMAC block
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4033,7 +4033,7 @@ static void sam_emac_disableclk(struct sam_emac_s *priv)
* Description: * Description:
* Reset the EMAC block. * Reset the EMAC block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4093,7 +4093,7 @@ static void sam_emac_reset(struct sam_emac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4133,7 +4133,7 @@ static void sam_macaddress(struct sam_emac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4206,7 +4206,7 @@ static void sam_ipv6multicast(struct sam_emac_s *priv)
* Description: * Description:
* Configure the EMAC interface for normal operation. * Configure the EMAC interface for normal operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
arch/arm/src/sama5/sam_ethernet.c
+3 -3
View File
@@ -70,7 +70,7 @@
* Description: * Description:
* Initialize the GMAC driver * Initialize the GMAC driver
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
@@ -101,7 +101,7 @@ static inline void up_gmac_initialize(void)
* Description: * Description:
* Initialize the EMAC driver * Initialize the EMAC driver
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
@@ -164,7 +164,7 @@ static inline void up_emac_initialize(void)
* and GMAC are enabled, then this single entry point must initialize * and GMAC are enabled, then this single entry point must initialize
* both. * both.
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
arch/arm/src/sama5/sam_ethernet.h
+1 -1
View File
@@ -319,7 +319,7 @@ int sam_emac_initialize(int intf);
* logic must provide sam_phyinitialize(); The SAMA5 Ethernet driver will call * logic must provide sam_phyinitialize(); The SAMA5 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/sama5/sam_gmac.c
+39 -39
View File
@@ -664,7 +664,7 @@ static void sam_buffer_free(struct sam_gmac_s *priv)
* Start hardware transmission. Called either from the TX done interrupt * Start hardware transmission. Called either from the TX done interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -785,7 +785,7 @@ static int sam_transmit(struct sam_gmac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -866,7 +866,7 @@ static int sam_txpoll(struct net_driver_s *dev)
* 2. When new TX data is available (sam_txavail), and * 2. When new TX data is available (sam_txavail), and
* 3. After a TX timeout to restart the sending process (sam_txtimeout_expiry). * 3. After a TX timeout to restart the sending process (sam_txtimeout_expiry).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -902,7 +902,7 @@ static void sam_dopoll(struct sam_gmac_s *priv)
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1142,7 +1142,7 @@ static int sam_recvframe(struct sam_gmac_s *priv)
* An interrupt was received indicating the availability of onr or more * An interrupt was received indicating the availability of onr or more
* new RX packets in FIFO memory. * new RX packets in FIFO memory.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1293,7 +1293,7 @@ static void sam_receive(struct sam_gmac_s *priv)
* An interrupt was received indicating that one or more frames have * An interrupt was received indicating that one or more frames have
* completed transmission. * completed transmission.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1378,7 +1378,7 @@ static void sam_txdone(struct sam_gmac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -1595,7 +1595,7 @@ static void sam_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -1649,7 +1649,7 @@ static int sam_gmac_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1685,7 +1685,7 @@ static void sam_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1719,7 +1719,7 @@ static void sam_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -1759,7 +1759,7 @@ static void sam_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -1787,7 +1787,7 @@ static void sam_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the GMAC interface when an IP address is * NuttX Callback: Bring up the GMAC interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1866,7 +1866,7 @@ static int sam_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1913,7 +1913,7 @@ static int sam_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -1951,7 +1951,7 @@ static void sam_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2117,7 +2117,7 @@ static unsigned int sam_hashindx(const uint8_t *mac)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2190,7 +2190,7 @@ static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2289,7 +2289,7 @@ static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2387,7 +2387,7 @@ static int sam_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Dump the contents of PHY registers * Dump the contents of PHY registers
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2437,7 +2437,7 @@ static void sam_phydump(struct sam_gmac_s *priv)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2487,7 +2487,7 @@ static int sam_phyintenable(struct sam_gmac_s *priv)
* Description: * Description:
* Enable the management port * Enable the management port
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2519,7 +2519,7 @@ static void sam_enablemdio(struct sam_gmac_s *priv)
* Description: * Description:
* Disable the management port * Disable the management port
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2553,7 +2553,7 @@ static void sam_disablemdio(struct sam_gmac_s *priv)
* Description: * Description:
* Wait for the PHY to become IDLE * Wait for the PHY to become IDLE
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2586,7 +2586,7 @@ static int sam_phywait(struct sam_gmac_s *priv)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2647,7 +2647,7 @@ static int sam_phyreset(struct sam_gmac_s *priv)
* Description: * Description:
* Verify the PHY address and, if it is bad, try to one that works. * Verify the PHY address and, if it is bad, try to one that works.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2723,7 +2723,7 @@ static int sam_phyfind(struct sam_gmac_s *priv, uint8_t *phyaddr)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2778,7 +2778,7 @@ static int sam_phyread(struct sam_gmac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -2830,7 +2830,7 @@ static int sam_phywrite(struct sam_gmac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Autonegotiate speed and duplex. * Autonegotiate speed and duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3117,7 +3117,7 @@ errout:
* If autonegotiation is not configured, then just force the configuration * If autonegotiation is not configured, then just force the configuration
* mode * mode
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3162,7 +3162,7 @@ statoc void sam_linkspeed(struct sam_gmac_s *priv)
* Description: * Description:
* Configure the MDC clocking * Configure the MDC clocking
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3227,7 +3227,7 @@ static void sam_mdcclock(struct sam_gmac_s *priv)
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3265,7 +3265,7 @@ static int sam_phyinit(struct sam_gmac_s *priv)
* Description: * Description:
* Configure GPIOs for the GMAC interface. * Configure GPIOs for the GMAC interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3306,7 +3306,7 @@ static inline void sam_ethgpioconfig(struct sam_gmac_s *priv)
* Description: * Description:
* Reset the transmit logic * Reset the transmit logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3371,7 +3371,7 @@ static void sam_txreset(struct sam_gmac_s *priv)
* Description: * Description:
* Reset the receive logic * Reset the receive logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3435,7 +3435,7 @@ static void sam_rxreset(struct sam_gmac_s *priv)
* Description: * Description:
* Reset the GMAC block. * Reset the GMAC block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3493,7 +3493,7 @@ static void sam_gmac_reset(struct sam_gmac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3533,7 +3533,7 @@ static void sam_macaddress(struct sam_gmac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3606,7 +3606,7 @@ static void sam_ipv6multicast(struct sam_gmac_s *priv)
* Description: * Description:
* Configure the GMAC interface for normal operation. * Configure the GMAC interface for normal operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
arch/arm/src/samv7/sam_emac.c
+42 -42
View File
@@ -1363,7 +1363,7 @@ static void sam_buffer_free(struct sam_emac_s *priv)
* *
* REVISIT: This implementation does not support scatter-gather DMA. * REVISIT: This implementation does not support scatter-gather DMA.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* qid - The queue to send the frame * qid - The queue to send the frame
* *
@@ -1502,7 +1502,7 @@ static int sam_transmit(struct sam_emac_s *priv, int qid)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1585,7 +1585,7 @@ static int sam_txpoll(struct net_driver_s *dev)
* 4. After a TX timeout to restart the sending process * 4. After a TX timeout to restart the sending process
* (sam_txtimeout_process). * (sam_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* qid - The transfer queue to send packets on * qid - The transfer queue to send packets on
* *
@@ -1622,7 +1622,7 @@ static void sam_dopoll(struct sam_emac_s *priv, int qid)
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* qid - The transfer queue to receive the frame * qid - The transfer queue to receive the frame
* *
@@ -1888,7 +1888,7 @@ static int sam_recvframe(struct sam_emac_s *priv, int qid)
* An interrupt was received indicating the availability of one or more * An interrupt was received indicating the availability of one or more
* new RX packets in FIFO memory. * new RX packets in FIFO memory.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* qid - The transfer queue on which the packet was recieved * qid - The transfer queue on which the packet was recieved
* *
@@ -2046,7 +2046,7 @@ static void sam_receive(struct sam_emac_s *priv, int qid)
* An interrupt was received indicating that one or more frames have * An interrupt was received indicating that one or more frames have
* completed transmission. * completed transmission.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* qid - The transfer queue on which the packet was sent * qid - The transfer queue on which the packet was sent
* *
@@ -2145,7 +2145,7 @@ static void sam_txdone(struct sam_emac_s *priv, int qid)
* Description: * Description:
* TX error interrupt processing. * TX error interrupt processing.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* quid - Index of the transfer queue that generated the interrupt * quid - Index of the transfer queue that generated the interrupt
* *
@@ -2273,7 +2273,7 @@ static void sam_txerr_interrupt(FAR struct sam_emac_s *priv, int qid)
* Description: * Description:
* Perform interrupt related work from the worker thread. * Perform interrupt related work from the worker thread.
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -2472,7 +2472,7 @@ static void sam_interrupt_work(FAR void *arg)
* Description: * Description:
* Common hardware interrupt handler. * Common hardware interrupt handler.
* *
* Parameters: * Input Parameters:
* priv - Reference to the EMAC private state structure * priv - Reference to the EMAC private state structure
* *
* Returned Value: * Returned Value:
@@ -2527,7 +2527,7 @@ static int sam_emac_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2565,7 +2565,7 @@ static void sam_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2599,7 +2599,7 @@ static void sam_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2639,7 +2639,7 @@ static void sam_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2667,7 +2667,7 @@ static void sam_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the EMAC interface when an IP address is * NuttX Callback: Bring up the EMAC interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2764,7 +2764,7 @@ static int sam_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2811,7 +2811,7 @@ static int sam_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2849,7 +2849,7 @@ static void sam_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -3015,7 +3015,7 @@ static unsigned int sam_hashindx(const uint8_t *mac)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -3087,7 +3087,7 @@ static int sam_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -3185,7 +3185,7 @@ static int sam_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -3287,7 +3287,7 @@ static int sam_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* Description: * Description:
* Dump the contents of PHY registers * Dump the contents of PHY registers
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3335,7 +3335,7 @@ static void sam_phydump(struct sam_emac_s *priv)
* Description: * Description:
* Helpers to simplify decoding PHY status register bits * Helpers to simplify decoding PHY status register bits
* *
* Parameters: * Input Parameters:
* physr - The value of the PHY status register * physr - The value of the PHY status register
* *
* Returned Value: * Returned Value:
@@ -3433,7 +3433,7 @@ static bool sam_is100fdx(struct sam_emac_s *priv, uint16_t physr)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3497,7 +3497,7 @@ static int sam_phyintenable(struct sam_emac_s *priv)
* Description: * Description:
* Wait for the PHY to become IDLE * Wait for the PHY to become IDLE
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3530,7 +3530,7 @@ static int sam_phywait(struct sam_emac_s *priv)
* Description: * Description:
* Reset the PHY * Reset the PHY
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3596,7 +3596,7 @@ static int sam_phyreset(struct sam_emac_s *priv)
* Description: * Description:
* Verify the PHY address and, if it is bad, try to one that works. * Verify the PHY address and, if it is bad, try to one that works.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3679,7 +3679,7 @@ static int sam_phyfind(struct sam_emac_s *priv, uint8_t *phyaddr)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -3744,7 +3744,7 @@ static int sam_phyread(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* phyaddr - The PHY device address * phyaddr - The PHY device address
* regaddr - The PHY register address * regaddr - The PHY register address
@@ -3806,7 +3806,7 @@ static int sam_phywrite(struct sam_emac_s *priv, uint8_t phyaddr,
* Description: * Description:
* Autonegotiate speed and duplex. * Autonegotiate speed and duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4041,7 +4041,7 @@ errout:
* Description: * Description:
* Check if the link is up * Check if the link is up
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4138,7 +4138,7 @@ errout:
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4229,7 +4229,7 @@ static int sam_phyinit(struct sam_emac_s *priv)
* MDC Management Data Clock MDC MDC * MDC Management Data Clock MDC MDC
* MDIO Management Data Input/Output MDIO MDIO * MDIO Management Data Input/Output MDIO MDIO
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4321,7 +4321,7 @@ static inline void sam_ethgpioconfig(struct sam_emac_s *priv)
* Description: * Description:
* Reset the transmit logic * Reset the transmit logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* qid - Identifies the queue to be reset * qid - Identifies the queue to be reset
* *
@@ -4392,7 +4392,7 @@ static void sam_txreset(struct sam_emac_s *priv, int qid)
* Description: * Description:
* Reset the receive logic * Reset the receive logic
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* qid - The transfer queue to be reset * qid - The transfer queue to be reset
* *
@@ -4463,7 +4463,7 @@ static void sam_rxreset(struct sam_emac_s *priv, int qid)
* Description: * Description:
* Enable clocking to the EMAC block * Enable clocking to the EMAC block
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4505,7 +4505,7 @@ static void sam_emac_enableclk(struct sam_emac_s *priv)
* Description: * Description:
* Disable clocking to the EMAC block * Disable clocking to the EMAC block
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4549,7 +4549,7 @@ static void sam_emac_disableclk(struct sam_emac_s *priv)
* Description: * Description:
* Reset the EMAC block. * Reset the EMAC block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4655,7 +4655,7 @@ static void sam_emac_reset(struct sam_emac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4695,7 +4695,7 @@ static void sam_macaddress(struct sam_emac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4768,7 +4768,7 @@ static void sam_ipv6multicast(struct sam_emac_s *priv)
* Description: * Description:
* Put transfer queue 0 in the operational state * Put transfer queue 0 in the operational state
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4821,7 +4821,7 @@ static int sam_queue0_configure(struct sam_emac_s *priv)
* Description: * Description:
* Put transfer queue n, n=1..(EMAC_NQUEUES-1), in the operational state * Put transfer queue n, n=1..(EMAC_NQUEUES-1), in the operational state
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* qid - Identifies the transfer queue to be configured * qid - Identifies the transfer queue to be configured
* *
@@ -4859,7 +4859,7 @@ static int sam_queue_configure(struct sam_emac_s *priv, int qid)
* Description: * Description:
* Configure the EMAC interface for normal operation. * Configure the EMAC interface for normal operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
arch/arm/src/samv7/sam_ethernet.c
+1 -1
View File
@@ -58,7 +58,7 @@
* sam_emac_intiialize() and to provide support for future chips that * sam_emac_intiialize() and to provide support for future chips that
* may have multiple EMAC peripherals. * may have multiple EMAC peripherals.
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
arch/arm/src/samv7/sam_ethernet.h
+1 -1
View File
@@ -245,7 +245,7 @@ int sam_emac_setmacaddr(int intf, uint8_t mac[6]);
* logic must provide sam_phyinitialize(); The SAMV7 Ethernet driver will call * logic must provide sam_phyinitialize(); The SAMV7 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32/stm32_bbsram.c
+2 -2
View File
@@ -718,7 +718,7 @@ static int stm32_bbsram_probe(int *ent, struct stm32_bbsram_s pdev[])
* Description: * Description:
* Initialize the Battery Backed up SRAM driver. * Initialize the Battery Backed up SRAM driver.
* *
* Parameters: * Input Parameters:
* devpath - the path to instantiate the files. * devpath - the path to instantiate the files.
* sizes - Pointer to a any array of file sizes to create * sizes - Pointer to a any array of file sizes to create
* the last entry should be 0 * the last entry should be 0
@@ -799,7 +799,7 @@ int stm32_bbsraminitialize(char *devpath, int *sizes)
* Description: * Description:
* Saves the panic context in a previously allocated BBSRAM file * Saves the panic context in a previously allocated BBSRAM file
* *
* Parameters: * Input Parameters:
* fileno - the value returned by the ioctl STM32_BBSRAM_GETDESC_IOCTL * fileno - the value returned by the ioctl STM32_BBSRAM_GETDESC_IOCTL
* context - Pointer to a any array of bytes to save * context - Pointer to a any array of bytes to save
* length - The length of the data pointed to byt context * length - The length of the data pointed to byt context
arch/arm/src/stm32/stm32_bbsram.h
+1 -1
View File
@@ -117,7 +117,7 @@ extern "C"
* Description: * Description:
* Initialize the Battery Backed up SRAM driver. * Initialize the Battery Backed up SRAM driver.
* *
* Parameters: * Input Parameters:
* devpath - the path to instantiate the files. * devpath - the path to instantiate the files.
* sizes - Pointer to a any array of file sizes to create * sizes - Pointer to a any array of file sizes to create
* the last entry should be 0 * the last entry should be 0
arch/arm/src/stm32/stm32_dma2d.c
+30 -30
View File
@@ -400,7 +400,7 @@ static struct stm32_interrupt_s g_interrupt =
* Description: * Description:
* Change the DMA2D control register * Change the DMA2D control register
* *
* Parameter: * Input Parameters:
* setbits - The bits to set * setbits - The bits to set
* clrbits - The bits to clear * clrbits - The bits to clear
* *
@@ -529,7 +529,7 @@ static int stm32_dma2d_waitforirq(void)
* Description: * Description:
* Starts clut loading but doesn't wait until loading is complete! * Starts clut loading but doesn't wait until loading is complete!
* *
* Parameter: * Input Parameters:
* pfcreg - PFC control Register * pfcreg - PFC control Register
* *
* Returned Value: * Returned Value:
@@ -575,7 +575,7 @@ static int stm32_dma2d_loadclut(uintptr_t pfcreg)
* Description: * Description:
* Starts the dma transfer and waits until completed. * Starts the dma transfer and waits until completed.
* *
* Parameter: * Input Parameters:
* reg - Register to set the start * reg - Register to set the start
* startflag - The related flag to start the dma transfer * startflag - The related flag to start the dma transfer
* irqflag - The interrupt enable flag in the DMA2D_CR register * irqflag - The interrupt enable flag in the DMA2D_CR register
@@ -617,7 +617,7 @@ static int stm32_dma2d_start(void)
* Description: * Description:
* Helper to calculate the layer memory address * Helper to calculate the layer memory address
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
* Returned Value: * Returned Value:
@@ -643,7 +643,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Helper to calculate the layer line offset * Helper to calculate the layer line offset
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
* Returned Value: * Returned Value:
@@ -666,7 +666,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Helper to map to dma2d controller pixel format * Helper to map to dma2d controller pixel format
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* fmt - Reference to the location to store the pixel format * fmt - Reference to the location to store the pixel format
* *
@@ -725,7 +725,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap)
* Description: * Description:
* Helper to get the bits per pixel * Helper to get the bits per pixel
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* bpp - Reference to the location to store the pixel format * bpp - Reference to the location to store the pixel format
* *
@@ -902,7 +902,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer)
* Description: * Description:
* Helper to check if area is outside the whole layer. * Helper to check if area is outside the whole layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* xpos - The x position inside the whole layer * xpos - The x position inside the whole layer
* ypos - The y position inside the whole layer * ypos - The y position inside the whole layer
@@ -928,7 +928,7 @@ static bool stm32_dma2d_lvalidatesize(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Initialize the internal layer structure * Initialize the internal layer structure
* *
* Parameter: * Input Parameters:
* *
* *
****************************************************************************/ ****************************************************************************/
@@ -977,7 +977,7 @@ static void stm32_dma2d_linit(FAR struct stm32_dma2d_s *layer,
* Configures the memory address register * Configures the memory address register
* Configures the line offset register * Configures the line offset register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -999,7 +999,7 @@ static void stm32_dma2d_lfifo(FAR const struct stm32_dma2d_s *layer, int lid,
* Description: * Description:
* Set the color for the layer * Set the color for the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1017,7 +1017,7 @@ static void stm32_dma2d_lcolor(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Set the number of line register * Set the number of line register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* area - Reference to the area to copy * area - Reference to the area to copy
* *
@@ -1041,7 +1041,7 @@ static void stm32_dma2d_llnr(FAR struct stm32_dma2d_s *layer,
* Description: * Description:
* Set the output PFC control register * Set the output PFC control register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1074,7 +1074,7 @@ static int stm32_dma2d_loutpfc(FAR const struct stm32_dma2d_s *layer)
* Description: * Description:
* Configure foreground and background layer PFC control register * Configure foreground and background layer PFC control register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1158,7 +1158,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Get video information about the layer * Get video information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* vinfo - Reference to the video info structure * vinfo - Reference to the video info structure
* *
@@ -1194,7 +1194,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get plane information about the layer * Get plane information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* planeno - Number of the plane * planeno - Number of the plane
* pinfo - Reference to the plane info structure * pinfo - Reference to the plane info structure
@@ -1231,7 +1231,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno,
* Description: * Description:
* Get a specific layer identifier. * Get a specific layer identifier.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* lid - Reference to store the layer id * lid - Reference to store the layer id
* *
@@ -1267,7 +1267,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid)
* Configure layer clut (color lookup table). * Configure layer clut (color lookup table).
* Non clut is defined during initializing. * Non clut is defined during initializing.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - color lookup table with up the 256 entries * cmap - color lookup table with up the 256 entries
* *
@@ -1385,7 +1385,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get configured layer clut (color lookup table). * Get configured layer clut (color lookup table).
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - Reference to valid color lookup table accept up the 256 color * cmap - Reference to valid color lookup table accept up the 256 color
* entries * entries
@@ -1478,7 +1478,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer,
* alpha value for blend operation. * alpha value for blend operation.
* Default value during initializing: 0xff * Default value during initializing: 0xff
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Alpha value * alpha - Alpha value
* *
@@ -1513,7 +1513,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha)
* Description: * Description:
* Get configured layer alpha value factor for blend operation. * Get configured layer alpha value factor for blend operation.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Reference to store the alpha value * alpha - Reference to store the alpha value
* *
@@ -1550,7 +1550,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha)
* Default mode during initializing: DMA2D_BLEND_NONE * Default mode during initializing: DMA2D_BLEND_NONE
* Blendmode is active after next update. * Blendmode is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Blend mode (see DMA2D_BLEND_*) * mode - Blend mode (see DMA2D_BLEND_*)
* *
@@ -1599,7 +1599,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get configured blend mode of the layer. * Get configured blend mode of the layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Reference to store the blend mode * mode - Reference to store the blend mode
* *
@@ -1636,7 +1636,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer,
* Copy selected area from a source layer to selected position of the * Copy selected area from a source layer to selected position of the
* destination layer. * destination layer.
* *
* Parameter: * Input Parameters:
* dest - Valid reference to the destination layer * dest - Valid reference to the destination layer
* destxpos - Valid selected x position of the destination layer * destxpos - Valid selected x position of the destination layer
* destypos - Valid selected y position of the destination layer * destypos - Valid selected y position of the destination layer
@@ -1744,7 +1744,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest,
* layer keeps unchanged as long destination layer is unequal to the * layer keeps unchanged as long destination layer is unequal to the
* foreground and background layer. * foreground and background layer.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* fore - Reference to the foreground layer * fore - Reference to the foreground layer
* forexpos - Selected x target position of the foreground layer * forexpos - Selected x target position of the foreground layer
@@ -1853,7 +1853,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest,
* Description: * Description:
* Fill the selected area of the whole layer with a specific color. * Fill the selected area of the whole layer with a specific color.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* area - Reference to the valid area structure select the area * area - Reference to the valid area structure select the area
* color - Color to fill the selected area. Color must be formatted * color - Color to fill the selected area. Color must be formatted
@@ -1932,7 +1932,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get a dma2d layer structure by the layer identifier * Get a dma2d layer structure by the layer identifier
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -1963,7 +1963,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid)
* Description: * Description:
* Create a new dma2d layer object to interact with the dma2d controller * Create a new dma2d layer object to interact with the dma2d controller
* *
* Parameter: * Input Parameters:
* width - Layer width * width - Layer width
* height - Layer height * height - Layer height
* fmt - Pixel format of the layer * fmt - Pixel format of the layer
@@ -2087,7 +2087,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width,
* Description: * Description:
* Remove and deallocate the dma2d layer * Remove and deallocate the dma2d layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer to remove * layer - Reference to the layer to remove
* *
* Returned Value: * Returned Value:
@@ -2244,7 +2244,7 @@ void up_dma2duninitialize(void)
* 2. Share the planeinfo information * 2. Share the planeinfo information
* 3. Share the videoinfo information * 3. Share the videoinfo information
* *
* Parameter: * Input Parameters:
* layer - a valid reference to the low level ltdc layer structure * layer - a valid reference to the low level ltdc layer structure
* clut - a pointer to a valid memory region to hold 256 clut colors * clut - a pointer to a valid memory region to hold 256 clut colors
* *
arch/arm/src/stm32/stm32_dma2d.h
+4 -4
View File
@@ -337,7 +337,7 @@ struct stm32_ltdc_s; /* Forward declaration */
* 2. Share the planeinfo information * 2. Share the planeinfo information
* 3. Share the videoinfo information * 3. Share the videoinfo information
* *
* Parameter: * Input Parameters:
* layer - a valid reference to the low level ltdc layer structure * layer - a valid reference to the low level ltdc layer structure
* *
* Returned Value: * Returned Value:
@@ -355,7 +355,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer);
* Description: * Description:
* Get a dma2d layer structure by the layer identifier * Get a dma2d layer structure by the layer identifier
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -372,7 +372,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid);
* Description: * Description:
* Create a new dma2d layer object to interact with the dma2d controller * Create a new dma2d layer object to interact with the dma2d controller
* *
* Parameter: * Input Parameters:
* width - Layer width * width - Layer width
* height - Layer height * height - Layer height
* fmt - Pixel format of the layer * fmt - Pixel format of the layer
@@ -396,7 +396,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width,
* Description: * Description:
* Remove and deallocate the dma2d layer * Remove and deallocate the dma2d layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer to remove * layer - Reference to the layer to remove
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32/stm32_eth.c
+44 -44
View File
@@ -896,7 +896,7 @@ static void stm32_checksetup(void)
* Description: * Description:
* Initialize the free buffer list. * Initialize the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -933,7 +933,7 @@ static void stm32_initbuffer(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Allocate one buffer from the free buffer list. * Allocate one buffer from the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -959,7 +959,7 @@ static inline uint8_t *stm32_allocbuffer(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Return a buffer to the free buffer list. * Return a buffer to the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* buffer - A pointer to the buffer to be freed * buffer - A pointer to the buffer to be freed
* *
@@ -986,7 +986,7 @@ static inline void stm32_freebuffer(FAR struct stm32_ethmac_s *priv, uint8_t *bu
* Description: * Description:
* Return TRUE if the free buffer list is not empty. * Return TRUE if the free buffer list is not empty.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1012,7 +1012,7 @@ static inline bool stm32_isfreebuffer(FAR struct stm32_ethmac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1223,7 +1223,7 @@ static int stm32_transmit(FAR struct stm32_ethmac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1330,7 +1330,7 @@ static int stm32_txpoll(struct net_driver_s *dev)
* 3. After a TX timeout to restart the sending process * 3. After a TX timeout to restart the sending process
* (stm32_txtimeout_process). * (stm32_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1391,7 +1391,7 @@ static void stm32_dopoll(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Enable a "normal" interrupt * Enable a "normal" interrupt
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1419,7 +1419,7 @@ static void stm32_enableint(FAR struct stm32_ethmac_s *priv, uint32_t ierbit)
* Description: * Description:
* Disable a normal interrupt. * Disable a normal interrupt.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1458,7 +1458,7 @@ static void stm32_disableint(FAR struct stm32_ethmac_s *priv, uint32_t ierbit)
* The function is called when a frame is received using the DMA receive * The function is called when a frame is received using the DMA receive
* interrupt. It scans the RX descriptors to the received frame. * interrupt. It scans the RX descriptors to the received frame.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1514,7 +1514,7 @@ static void stm32_freesegment(FAR struct stm32_ethmac_s *priv,
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1677,7 +1677,7 @@ static int stm32_recvframe(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1849,7 +1849,7 @@ static void stm32_receive(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Scans the TX descriptors and frees the buffers of completed TX transfers. * Scans the TX descriptors and frees the buffers of completed TX transfers.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1946,7 +1946,7 @@ static void stm32_freeframe(FAR struct stm32_ethmac_s *priv)
* An interrupt was received indicating that the last TX packet * An interrupt was received indicating that the last TX packet
* transfer(s) are complete. * transfer(s) are complete.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1989,7 +1989,7 @@ static void stm32_txdone(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -2096,7 +2096,7 @@ static void stm32_interrupt_work(FAR void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -2150,7 +2150,7 @@ static int stm32_interrupt(int irq, FAR void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2184,7 +2184,7 @@ static void stm32_txtimeout_work(FAR void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2224,7 +2224,7 @@ static void stm32_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2296,7 +2296,7 @@ static void stm32_poll_work(FAR void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2324,7 +2324,7 @@ static void stm32_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2378,7 +2378,7 @@ static int stm32_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2425,7 +2425,7 @@ static int stm32_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2463,7 +2463,7 @@ static void stm32_txavail_work(FAR void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2499,7 +2499,7 @@ static int stm32_txavail(struct net_driver_s *dev)
* Description: * Description:
* Function to calculate the CRC used by STM32 to check an ethernet frame * Function to calculate the CRC used by STM32 to check an ethernet frame
* *
* Parameters: * Input Parameters:
* data - the data to be checked * data - the data to be checked
* length - length of the data * length - length of the data
* *
@@ -2544,7 +2544,7 @@ static uint32_t stm32_calcethcrc(const uint8_t *data, size_t length)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2601,7 +2601,7 @@ static int stm32_addmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2663,7 +2663,7 @@ static int stm32_rmmac(struct net_driver_s *dev, FAR const uint8_t *mac)
* Description: * Description:
* Initializes the DMA TX descriptors in chain mode. * Initializes the DMA TX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2745,7 +2745,7 @@ static void stm32_txdescinit(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Initializes the DMA RX descriptors in chain mode. * Initializes the DMA RX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2836,7 +2836,7 @@ static void stm32_rxdescinit(FAR struct stm32_ethmac_s *priv)
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -2917,7 +2917,7 @@ static int stm32_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -2950,7 +2950,7 @@ static int stm32_phyintenable(struct stm32_ethmac_s *priv)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The location to return the 16-bit PHY register value. * value - The location to return the 16-bit PHY register value.
@@ -3008,7 +3008,7 @@ static int stm32_phyread(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t *val
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The 16-bit value to write to the PHY register value. * value - The 16-bit value to write to the PHY register value.
@@ -3071,7 +3071,7 @@ static int stm32_phywrite(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t val
* fundamental issue with the PHY clocking initialization, but the * fundamental issue with the PHY clocking initialization, but the
* root cause has not been studied (nor will it be with this workaround). * root cause has not been studied (nor will it be with this workaround).
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3133,7 +3133,7 @@ static inline int stm32_dm9161(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3415,7 +3415,7 @@ static inline void stm32_selectrmii(void)
* Description: * Description:
* Configure GPIOs for the Ethernet interface. * Configure GPIOs for the Ethernet interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3568,7 +3568,7 @@ static inline void stm32_ethgpioconfig(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Reset the Ethernet block. * Reset the Ethernet block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3624,7 +3624,7 @@ static void stm32_ethreset(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet MAC for DMA operation. * Configure the Ethernet MAC for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3707,7 +3707,7 @@ static int stm32_macconfig(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3749,7 +3749,7 @@ static void stm32_macaddress(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3822,7 +3822,7 @@ static void stm32_ipv6multicast(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Enable normal MAC operation. * Enable normal MAC operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3908,7 +3908,7 @@ static int stm32_macenable(FAR struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet interface for DMA operation. * Configure the Ethernet interface for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3980,7 +3980,7 @@ static int stm32_ethconfig(FAR struct stm32_ethmac_s *priv)
* must implement up_netinitialize() and call this function to initialize * must implement up_netinitialize() and call this function to initialize
* the desired interfaces. * the desired interfaces.
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value * intf - In the case where there are multiple EMACs, this value
* identifies which EMAC is to be initialized. * identifies which EMAC is to be initialized.
* *
@@ -4059,7 +4059,7 @@ int stm32_ethinitialize(int intf)
* version of up_netinitialize() that calls stm32_ethinitialize() with * version of up_netinitialize() that calls stm32_ethinitialize() with
* the appropriate interface number. * the appropriate interface number.
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32/stm32_eth.h
+2 -2
View File
@@ -71,7 +71,7 @@ extern "C"
* multiple Ethernet controllers, then board specific logic must implement * multiple Ethernet controllers, then board specific logic must implement
* up_netinitialize() and call this function to initialize the desired interfaces. * up_netinitialize() and call this function to initialize the desired interfaces.
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value identifies which * intf - In the case where there are multiple EMACs, this value identifies which
* EMAC is to be initialized. * EMAC is to be initialized.
* *
@@ -96,7 +96,7 @@ int stm32_ethinitialize(int intf);
* logic must provide stm32_phyinitialize(); The STM32 Ethernet driver will call * logic must provide stm32_phyinitialize(); The STM32 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32/stm32_exti.h
+1 -1
View File
@@ -117,7 +117,7 @@ int stm32_exti_alarm(bool risingedge, bool fallingedge, bool event, xcpt_t func,
* Description: * Description:
* Sets/clears EXTI wakeup interrupt. * Sets/clears EXTI wakeup interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edges * - rising/falling edge: enables interrupt on rising/falling edges
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32/stm32_exti_alarm.c
+1 -1
View File
@@ -102,7 +102,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI alarm interrupt. * Sets/clears EXTI alarm interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32/stm32_exti_pwr.c
+1 -1
View File
@@ -108,7 +108,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32/stm32_exti_pwr.h
+1 -1
View File
@@ -53,7 +53,7 @@
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32/stm32_exti_wakeup.c
+1 -1
View File
@@ -102,7 +102,7 @@ static int stm32_exti_wakeup_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI wakeup interrupt. * Sets/clears EXTI wakeup interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edges * - rising/falling edge: enables interrupt on rising/falling edges
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32/stm32_ltdc.c
+49 -49
View File
@@ -1016,7 +1016,7 @@ static void stm32_ltdc_periphconfig(void)
* Description: * Description:
* Configures background color of the LCD controller. * Configures background color of the LCD controller.
* *
* Parameter: * Input Parameters:
* rgb - RGB888 background color * rgb - RGB888 background color
* *
****************************************************************************/ ****************************************************************************/
@@ -1034,7 +1034,7 @@ static void stm32_ltdc_bgcolor(uint32_t rgb)
* Description: * Description:
* Configures dither settings of the LCD controller. * Configures dither settings of the LCD controller.
* *
* Parameter: * Input Parameters:
* enable - Enable dithering * enable - Enable dithering
* red - Red dither width * red - Red dither width
* green - Green dither width * green - Green dither width
@@ -1092,7 +1092,7 @@ static void stm32_ltdc_linepos(void)
* Description: * Description:
* Control interrupts generated by the ltdc controller * Control interrupts generated by the ltdc controller
* *
* Parameter: * Input Parameters:
* setirqs - set interrupt mask * setirqs - set interrupt mask
* clrirqs - clear interrupt mask * clrirqs - clear interrupt mask
* *
@@ -1208,7 +1208,7 @@ static int stm32_ltdc_waitforirq(void)
* Note! The caller must ensure that a previous register reloading has been * Note! The caller must ensure that a previous register reloading has been
* completed. * completed.
* *
* Parameter: * Input Parameters:
* value - Reload flag (e.g. upon vertical blank or immediately) * value - Reload flag (e.g. upon vertical blank or immediately)
* waitvblank - Wait until register reload is finished * waitvblank - Wait until register reload is finished
* *
@@ -1338,7 +1338,7 @@ static void stm32_global_configure(void)
* Description: * Description:
* Disable the LCD peripheral * Disable the LCD peripheral
* *
* Parameter: * Input Parameters:
* enable - Enable or disable * enable - Enable or disable
* *
****************************************************************************/ ****************************************************************************/
@@ -1370,7 +1370,7 @@ static void stm32_lcd_enable(bool enable)
* Description: * Description:
* Disable or enable the layer clut support * Disable or enable the layer clut support
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* enable - Enable or disable * enable - Enable or disable
* *
@@ -1406,7 +1406,7 @@ static void stm32_ltdc_lclutenable(FAR struct stm32_layer_s *layer, bool enable)
* Description: * Description:
* Helper to set the layer to opac * Helper to set the layer to opac
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1422,7 +1422,7 @@ static inline void stm32_ltdc_lsetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to set the layer opacity to the alpha value * Helper to set the layer opacity to the alpha value
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1438,7 +1438,7 @@ static inline void stm32_ltdc_lunsetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to get the configured layer opacity * Helper to get the configured layer opacity
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1454,7 +1454,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to check if the layer is an valid ltdc layer * Helper to check if the layer is an valid ltdc layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
* Returned Value: * Returned Value:
@@ -1478,7 +1478,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer)
* Description: * Description:
* Check if layer coordinates out of valid area. * Check if layer coordinates out of valid area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* xpos - top left x position of the active area * xpos - top left x position of the active area
* ypos - top left y position of the active area * ypos - top left y position of the active area
@@ -1535,7 +1535,7 @@ static int stm32_ltdc_lvalidatearea(FAR struct stm32_layer_s *layer,
* This made changes for the given layer visible after the next shadow * This made changes for the given layer visible after the next shadow
* register reload. * register reload.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1591,7 +1591,7 @@ static void stm32_ltdc_lupdate(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Change the active area of the layer * Change the active area of the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1645,7 +1645,7 @@ static void stm32_ltdc_larea(struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* Reference to the layer control structure * Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1668,7 +1668,7 @@ static void stm32_ltdc_lpixelformat(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* Reference to the layer control structure * Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1715,7 +1715,7 @@ static inline void stm32_ltdc_lframebuffer(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1740,7 +1740,7 @@ static void stm32_ltdc_lalpha(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the laxer control structure * layer - Reference to the laxer control structure
* bf1 - Value of blend factor 1 * bf1 - Value of blend factor 1
* bf2 - Value of blend factor 2 * bf2 - Value of blend factor 2
@@ -1768,7 +1768,7 @@ static void stm32_ltdc_lblendmode(FAR struct stm32_layer_s *layer,
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1791,7 +1791,7 @@ static void stm32_ltdc_lcolor(FAR struct stm32_layer_s *layer, uint32_t argb)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1836,7 +1836,7 @@ static void stm32_ltdc_lcolorkey(FAR struct stm32_layer_s *layer)
* Update the clut layer register during blank period. * Update the clut layer register during blank period.
* Note! The clut register are no shadow register. * Note! The clut register are no shadow register.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1918,7 +1918,7 @@ static void stm32_ltdc_lclut(FAR struct stm32_layer_s *layer,
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1954,7 +1954,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Clear the whole layer * Clear the whole layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* color - The color to clear * color - The color to clear
* *
@@ -2067,7 +2067,7 @@ static void stm32_ltdc_lclear(FAR struct stm32_layer_s *layer,
* - layer blendmode * - layer blendmode
* - layer dma2d interface binding * - layer dma2d interface binding
* *
* Parameter * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -2168,7 +2168,7 @@ static void stm32_ltdc_linit(int lid)
* Description: * Description:
* Get the videoinfo for the framebuffer * Get the videoinfo for the framebuffer
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* vinfo - the videoinfo object * vinfo - the videoinfo object
* *
@@ -2203,7 +2203,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable,
* Description: * Description:
* Get the planeinfo for the framebuffer * Get the planeinfo for the framebuffer
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* pinfo - the planeinfo object * pinfo - the planeinfo object
* *
@@ -2238,7 +2238,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno,
* Description: * Description:
* Get a range of CLUT values for the LCD * Get a range of CLUT values for the LCD
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* cmap - the color table * cmap - the color table
* *
@@ -2265,7 +2265,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable,
* Description: * Description:
* Set a range of the CLUT values for the LCD * Set a range of the CLUT values for the LCD
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* cmap - the color table * cmap - the color table
* *
@@ -2292,7 +2292,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable,
* Description: * Description:
* Get video information about the layer * Get video information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* vinfo - Reference to the video info structure * vinfo - Reference to the video info structure
* *
@@ -2325,7 +2325,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer,
* Description: * Description:
* Get plane information about the layer * Get plane information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* planeno - Number of the plane * planeno - Number of the plane
* pinfo - Reference to the plane info structure * pinfo - Reference to the plane info structure
@@ -2360,7 +2360,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno,
* Non clut is defined during initializing. * Non clut is defined during initializing.
* Clut is active during next vertical blank period. Do not need an update. * Clut is active during next vertical blank period. Do not need an update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - color lookup table with up the 256 entries * cmap - color lookup table with up the 256 entries
* *
@@ -2419,7 +2419,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer,
* Description: * Description:
* Get configured layer clut (color lookup table). * Get configured layer clut (color lookup table).
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - Reference to valid color lookup table accept up the 256 color * cmap - Reference to valid color lookup table accept up the 256 color
* entries * entries
@@ -2516,7 +2516,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer,
* Description: * Description:
* Get a specific layer identifier. * Get a specific layer identifier.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* lid - Reference to store the layer id * lid - Reference to store the layer id
* flag - Operation flag describe the layer identifier * flag - Operation flag describe the layer identifier
@@ -2596,7 +2596,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid,
* Default value during initializing: 0x00000000 * Default value during initializing: 0x00000000
* Color is active after next update. * Color is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* argb - ARGB8888 color value * argb - ARGB8888 color value
* *
@@ -2632,7 +2632,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb)
* Description: * Description:
* Get configured layer color for the non active layer area. * Get configured layer color for the non active layer area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* argb - Reference to store the ARGB8888 color value * argb - Reference to store the ARGB8888 color value
* *
@@ -2669,7 +2669,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb)
* Layer default value during initializing: 0x00000000 * Layer default value during initializing: 0x00000000
* Colorkey is active after next update. * Colorkey is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* rgb - RGB888 color value * rgb - RGB888 color value
* *
@@ -2705,7 +2705,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb)
* Description: * Description:
* Get the configured layer color key (chromakey) for transparency. * Get the configured layer color key (chromakey) for transparency.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* rgb - Reference to store the RGB888 color key * rgb - Reference to store the RGB888 color key
* *
@@ -2746,7 +2746,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb)
* Default alpha value during initializing: 0xff * Default alpha value during initializing: 0xff
* Alpha is active after next update. * Alpha is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Alpha value * alpha - Alpha value
* *
@@ -2782,7 +2782,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha)
* Description: * Description:
* Get configured layer alpha value factor for blend operation. * Get configured layer alpha value factor for blend operation.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Reference to store the alpha value * alpha - Reference to store the alpha value
* *
@@ -2819,7 +2819,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha)
* Default mode during initializing: LTDC_BLEND_NONE * Default mode during initializing: LTDC_BLEND_NONE
* Blendmode is active after next update. * Blendmode is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Blend mode (see LTDC_BLEND_*) * mode - Blend mode (see LTDC_BLEND_*)
* *
@@ -2951,7 +2951,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode)
* Description: * Description:
* Get configured blend mode of the layer. * Get configured blend mode of the layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Reference to store the blend mode * mode - Reference to store the blend mode
* *
@@ -2988,7 +2988,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode)
* the active area. * the active area.
* Area is active after next update. * Area is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* area - Reference to the valid area structure for the new active area * area - Reference to the valid area structure for the new active area
* srcxpos - x position of the visible pixel of the whole layer * srcxpos - x position of the visible pixel of the whole layer
@@ -3050,7 +3050,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer,
* Description: * Description:
* Get configured visible layer area. * Get configured visible layer area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* area - Reference to the area structure to store the active area * area - Reference to the area structure to store the active area
* srcxpos - Reference to store the referenced x position of the whole layer * srcxpos - Reference to store the referenced x position of the whole layer
@@ -3092,7 +3092,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer,
* Description: * Description:
* Update current layer settings and make changes visible. * Update current layer settings and make changes visible.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - operation mode * mode - operation mode
* *
@@ -3252,7 +3252,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode)
* Copy selected area from a source layer to selected position of the * Copy selected area from a source layer to selected position of the
* destination layer. * destination layer.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* destxpos - Selected x position of the destination layer * destxpos - Selected x position of the destination layer
* destypos - Selected y position of the destination layer * destypos - Selected y position of the destination layer
@@ -3300,7 +3300,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest,
* of the background layer. Copy the result to the destination layer. Note! * of the background layer. Copy the result to the destination layer. Note!
* The content of the foreground and background layer is not changed. * The content of the foreground and background layer is not changed.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* destxpos - Selected x position of the destination layer * destxpos - Selected x position of the destination layer
* destypos - Selected y position of the destination layer * destypos - Selected y position of the destination layer
@@ -3354,7 +3354,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest,
* Description: * Description:
* Fill the selected area of the whole layer with a specific color. * Fill the selected area of the whole layer with a specific color.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* area - Reference to the valid area structure select the area * area - Reference to the valid area structure select the area
* color - Color to fill the selected area. Color must be formatted * color - Color to fill the selected area. Color must be formatted
@@ -3399,7 +3399,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer,
* Get the specific layer object by the layer id to enable layer hardware * Get the specific layer object by the layer id to enable layer hardware
* support. * support.
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -3574,7 +3574,7 @@ void stm32_ltdcuninitialize(void)
* entire display can be slow. Here the display is cleared by simply setting * entire display can be slow. Here the display is cleared by simply setting
* all video memory to the specified color. * all video memory to the specified color.
* *
* Parameter: * Input Parameters:
* color - The color the clear the whole framebuffer * color - The color the clear the whole framebuffer
* *
****************************************************************************/ ****************************************************************************/
@@ -3593,7 +3593,7 @@ void stm32_lcdclear(nxgl_mxpixel_t color)
* Description: * Description:
* Provide this interface to turn the backlight on and off. * Provide this interface to turn the backlight on and off.
* *
* Parameter: * Input Parameters:
* blon - Enable or disable the lcd backlight * blon - Enable or disable the lcd backlight
* *
****************************************************************************/ ****************************************************************************/
arch/arm/src/stm32/stm32_ltdc.h
+1 -1
View File
@@ -622,7 +622,7 @@ void stm32_ltdcuninitialize(void);
* Description: * Description:
* Get the ltdc layer structure to perform hardware layer operation * Get the ltdc layer structure to perform hardware layer operation
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32f7/stm32_bbsram.c
+2 -2
View File
@@ -719,7 +719,7 @@ static int stm32_bbsram_probe(int *ent, struct stm32_bbsram_s pdev[])
* Description: * Description:
* Initialize the Battery Backed up SRAM driver. * Initialize the Battery Backed up SRAM driver.
* *
* Parameters: * Input Parameters:
* devpath - the path to instantiate the files. * devpath - the path to instantiate the files.
* sizes - Pointer to a any array of file sizes to create * sizes - Pointer to a any array of file sizes to create
* the last entry should be 0 * the last entry should be 0
@@ -800,7 +800,7 @@ int stm32_bbsraminitialize(char *devpath, int *sizes)
* Description: * Description:
* Saves the panic context in a previously allocated BBSRAM file * Saves the panic context in a previously allocated BBSRAM file
* *
* Parameters: * Input Parameters:
* fileno - the value returned by the ioctl STM32_BBSRAM_GETDESC_IOCTL * fileno - the value returned by the ioctl STM32_BBSRAM_GETDESC_IOCTL
* context - Pointer to a any array of bytes to save * context - Pointer to a any array of bytes to save
* length - The length of the data pointed to byt context * length - The length of the data pointed to byt context
arch/arm/src/stm32f7/stm32_bbsram.h
+1 -1
View File
@@ -117,7 +117,7 @@ extern "C"
* Description: * Description:
* Initialize the Battery Backed up SRAM driver. * Initialize the Battery Backed up SRAM driver.
* *
* Parameters: * Input Parameters:
* devpath - the path to instantiate the files. * devpath - the path to instantiate the files.
* sizes - Pointer to a any array of file sizes to create * sizes - Pointer to a any array of file sizes to create
* the last entry should be 0 * the last entry should be 0
arch/arm/src/stm32f7/stm32_dma2d.c
+30 -30
View File
@@ -395,7 +395,7 @@ static struct stm32_interrupt_s g_interrupt =
* Description: * Description:
* Change the DMA2D control register * Change the DMA2D control register
* *
* Parameter: * Input Parameters:
* setbits - The bits to set * setbits - The bits to set
* clrbits - The bits to clear * clrbits - The bits to clear
* *
@@ -523,7 +523,7 @@ static int stm32_dma2d_waitforirq(void)
* Description: * Description:
* Starts clut loading but doesn't wait until loading is complete! * Starts clut loading but doesn't wait until loading is complete!
* *
* Parameter: * Input Parameters:
* pfcreg - PFC control Register * pfcreg - PFC control Register
* *
* Returned Value: * Returned Value:
@@ -569,7 +569,7 @@ static int stm32_dma2d_loadclut(uintptr_t pfcreg)
* Description: * Description:
* Starts the dma transfer and waits until completed. * Starts the dma transfer and waits until completed.
* *
* Parameter: * Input Parameters:
* reg - Register to set the start * reg - Register to set the start
* startflag - The related flag to start the dma transfer * startflag - The related flag to start the dma transfer
* irqflag - The interrupt enable flag in the DMA2D_CR register * irqflag - The interrupt enable flag in the DMA2D_CR register
@@ -611,7 +611,7 @@ static int stm32_dma2d_start(void)
* Description: * Description:
* Helper to calculate the layer memory address * Helper to calculate the layer memory address
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
* Returned Value: * Returned Value:
@@ -637,7 +637,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Helper to calculate the layer line offset * Helper to calculate the layer line offset
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
* Returned Value: * Returned Value:
@@ -660,7 +660,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Helper to map to dma2d controller pixel format * Helper to map to dma2d controller pixel format
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* fmt - Reference to the location to store the pixel format * fmt - Reference to the location to store the pixel format
* *
@@ -719,7 +719,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap)
* Description: * Description:
* Helper to get the bits per pixel * Helper to get the bits per pixel
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* bpp - Reference to the location to store the pixel format * bpp - Reference to the location to store the pixel format
* *
@@ -896,7 +896,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer)
* Description: * Description:
* Helper to check if area is outside the whole layer. * Helper to check if area is outside the whole layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* xpos - The x position inside the whole layer * xpos - The x position inside the whole layer
* ypos - The y position inside the whole layer * ypos - The y position inside the whole layer
@@ -922,7 +922,7 @@ static bool stm32_dma2d_lvalidatesize(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Initialize the internal layer structure * Initialize the internal layer structure
* *
* Parameter: * Input Parameters:
* *
* *
****************************************************************************/ ****************************************************************************/
@@ -971,7 +971,7 @@ static void stm32_dma2d_linit(FAR struct stm32_dma2d_s *layer,
* Configures the memory address register * Configures the memory address register
* Configures the line offset register * Configures the line offset register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -993,7 +993,7 @@ static void stm32_dma2d_lfifo(FAR const struct stm32_dma2d_s *layer, int lid,
* Description: * Description:
* Set the color for the layer * Set the color for the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1011,7 +1011,7 @@ static void stm32_dma2d_lcolor(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Set the number of line register * Set the number of line register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* area - Reference to the area to copy * area - Reference to the area to copy
* *
@@ -1035,7 +1035,7 @@ static void stm32_dma2d_llnr(FAR struct stm32_dma2d_s *layer,
* Description: * Description:
* Set the output PFC control register * Set the output PFC control register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1068,7 +1068,7 @@ static int stm32_dma2d_loutpfc(FAR const struct stm32_dma2d_s *layer)
* Description: * Description:
* Configure foreground and background layer PFC control register * Configure foreground and background layer PFC control register
* *
* Parameter: * Input Parameters:
* layer - Reference to the common layer state structure * layer - Reference to the common layer state structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1152,7 +1152,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer,
* Description: * Description:
* Get video information about the layer * Get video information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* vinfo - Reference to the video info structure * vinfo - Reference to the video info structure
* *
@@ -1188,7 +1188,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get plane information about the layer * Get plane information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* planeno - Number of the plane * planeno - Number of the plane
* pinfo - Reference to the plane info structure * pinfo - Reference to the plane info structure
@@ -1225,7 +1225,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno,
* Description: * Description:
* Get a specific layer identifier. * Get a specific layer identifier.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* lid - Reference to store the layer id * lid - Reference to store the layer id
* *
@@ -1261,7 +1261,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid)
* Configure layer clut (color lookup table). * Configure layer clut (color lookup table).
* Non clut is defined during initializing. * Non clut is defined during initializing.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - color lookup table with up the 256 entries * cmap - color lookup table with up the 256 entries
* *
@@ -1379,7 +1379,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get configured layer clut (color lookup table). * Get configured layer clut (color lookup table).
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - Reference to valid color lookup table accept up the 256 color * cmap - Reference to valid color lookup table accept up the 256 color
* entries * entries
@@ -1472,7 +1472,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer,
* alpha value for blend operation. * alpha value for blend operation.
* Default value during initializing: 0xff * Default value during initializing: 0xff
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Alpha value * alpha - Alpha value
* *
@@ -1507,7 +1507,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha)
* Description: * Description:
* Get configured layer alpha value factor for blend operation. * Get configured layer alpha value factor for blend operation.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Reference to store the alpha value * alpha - Reference to store the alpha value
* *
@@ -1544,7 +1544,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha)
* Default mode during initializing: DMA2D_BLEND_NONE * Default mode during initializing: DMA2D_BLEND_NONE
* Blendmode is active after next update. * Blendmode is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Blend mode (see DMA2D_BLEND_*) * mode - Blend mode (see DMA2D_BLEND_*)
* *
@@ -1593,7 +1593,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get configured blend mode of the layer. * Get configured blend mode of the layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Reference to store the blend mode * mode - Reference to store the blend mode
* *
@@ -1630,7 +1630,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer,
* Copy selected area from a source layer to selected position of the * Copy selected area from a source layer to selected position of the
* destination layer. * destination layer.
* *
* Parameter: * Input Parameters:
* dest - Valid reference to the destination layer * dest - Valid reference to the destination layer
* destxpos - Valid selected x position of the destination layer * destxpos - Valid selected x position of the destination layer
* destypos - Valid selected y position of the destination layer * destypos - Valid selected y position of the destination layer
@@ -1738,7 +1738,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest,
* layer keeps unchanged as long destination layer is unequal to the * layer keeps unchanged as long destination layer is unequal to the
* foreground and background layer. * foreground and background layer.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* fore - Reference to the foreground layer * fore - Reference to the foreground layer
* forexpos - Selected x target position of the foreground layer * forexpos - Selected x target position of the foreground layer
@@ -1847,7 +1847,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest,
* Description: * Description:
* Fill the selected area of the whole layer with a specific color. * Fill the selected area of the whole layer with a specific color.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* area - Reference to the valid area structure select the area * area - Reference to the valid area structure select the area
* color - Color to fill the selected area. Color must be formatted * color - Color to fill the selected area. Color must be formatted
@@ -1926,7 +1926,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer,
* Description: * Description:
* Get a dma2d layer structure by the layer identifier * Get a dma2d layer structure by the layer identifier
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -1957,7 +1957,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid)
* Description: * Description:
* Create a new dma2d layer object to interact with the dma2d controller * Create a new dma2d layer object to interact with the dma2d controller
* *
* Parameter: * Input Parameters:
* width - Layer width * width - Layer width
* height - Layer height * height - Layer height
* fmt - Pixel format of the layer * fmt - Pixel format of the layer
@@ -2079,7 +2079,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width,
* Description: * Description:
* Remove and deallocate the dma2d layer * Remove and deallocate the dma2d layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer to remove * layer - Reference to the layer to remove
* *
* Returned Value: * Returned Value:
@@ -2236,7 +2236,7 @@ void up_dma2duninitialize(void)
* 2. Share the planeinfo information * 2. Share the planeinfo information
* 3. Share the videoinfo information * 3. Share the videoinfo information
* *
* Parameter: * Input Parameters:
* layer - a valid reference to the low level ltdc layer structure * layer - a valid reference to the low level ltdc layer structure
* clut - a pointer to a valid memory region to hold 256 clut colors * clut - a pointer to a valid memory region to hold 256 clut colors
* *
arch/arm/src/stm32f7/stm32_dma2d.h
+4 -4
View File
@@ -337,7 +337,7 @@ struct stm32_ltdc_s; /* Forward declaration */
* 2. Share the planeinfo information * 2. Share the planeinfo information
* 3. Share the videoinfo information * 3. Share the videoinfo information
* *
* Parameter: * Input Parameters:
* layer - a valid reference to the low level ltdc layer structure * layer - a valid reference to the low level ltdc layer structure
* *
* Returned Value: * Returned Value:
@@ -355,7 +355,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer);
* Description: * Description:
* Get a dma2d layer structure by the layer identifier * Get a dma2d layer structure by the layer identifier
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -372,7 +372,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid);
* Description: * Description:
* Create a new dma2d layer object to interact with the dma2d controller * Create a new dma2d layer object to interact with the dma2d controller
* *
* Parameter: * Input Parameters:
* width - Layer width * width - Layer width
* height - Layer height * height - Layer height
* fmt - Pixel format of the layer * fmt - Pixel format of the layer
@@ -396,7 +396,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width,
* Description: * Description:
* Remove and deallocate the dma2d layer * Remove and deallocate the dma2d layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer to remove * layer - Reference to the layer to remove
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32f7/stm32_ethernet.c
+44 -44
View File
@@ -906,7 +906,7 @@ static void stm32_checksetup(void)
* Description: * Description:
* Initialize the free buffer list. * Initialize the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* txbuffer - DMA memory allocated for TX buffers. * txbuffer - DMA memory allocated for TX buffers.
* *
@@ -944,7 +944,7 @@ static void stm32_initbuffer(struct stm32_ethmac_s *priv, uint8_t *txbuffer)
* Description: * Description:
* Allocate one buffer from the free buffer list. * Allocate one buffer from the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -970,7 +970,7 @@ static inline uint8_t *stm32_allocbuffer(struct stm32_ethmac_s *priv)
* Description: * Description:
* Return a buffer to the free buffer list. * Return a buffer to the free buffer list.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* buffer - A pointer to the buffer to be freed * buffer - A pointer to the buffer to be freed
* *
@@ -997,7 +997,7 @@ static inline void stm32_freebuffer(struct stm32_ethmac_s *priv, uint8_t *buffer
* Description: * Description:
* Return TRUE if the free buffer list is not empty. * Return TRUE if the free buffer list is not empty.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1023,7 +1023,7 @@ static inline bool stm32_isfreebuffer(struct stm32_ethmac_s *priv)
* Start hardware transmission. Called either from the txdone interrupt * Start hardware transmission. Called either from the txdone interrupt
* handling or from watchdog based polling. * handling or from watchdog based polling.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1258,7 +1258,7 @@ static int stm32_transmit(struct stm32_ethmac_s *priv)
* 2. When the preceding TX packet send timesout and the interface is reset * 2. When the preceding TX packet send timesout and the interface is reset
* 3. During normal TX polling * 3. During normal TX polling
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -1365,7 +1365,7 @@ static int stm32_txpoll(struct net_driver_s *dev)
* 3. After a TX timeout to restart the sending process * 3. After a TX timeout to restart the sending process
* (stm32_txtimeout_process). * (stm32_txtimeout_process).
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1426,7 +1426,7 @@ static void stm32_dopoll(struct stm32_ethmac_s *priv)
* Description: * Description:
* Enable a "normal" interrupt * Enable a "normal" interrupt
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1454,7 +1454,7 @@ static void stm32_enableint(struct stm32_ethmac_s *priv, uint32_t ierbit)
* Description: * Description:
* Disable a normal interrupt. * Disable a normal interrupt.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1493,7 +1493,7 @@ static void stm32_disableint(struct stm32_ethmac_s *priv, uint32_t ierbit)
* The function is called when a frame is received using the DMA receive * The function is called when a frame is received using the DMA receive
* interrupt. It scans the RX descriptors to the received frame. * interrupt. It scans the RX descriptors to the received frame.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1563,7 +1563,7 @@ static void stm32_freesegment(struct stm32_ethmac_s *priv,
* *
* NOTE: This function will silently discard any packets containing errors. * NOTE: This function will silently discard any packets containing errors.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1753,7 +1753,7 @@ static int stm32_recvframe(struct stm32_ethmac_s *priv)
* Description: * Description:
* An interrupt was received indicating the availability of a new RX packet * An interrupt was received indicating the availability of a new RX packet
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -1915,7 +1915,7 @@ static void stm32_receive(struct stm32_ethmac_s *priv)
* Description: * Description:
* Scans the TX descriptors and frees the buffers of completed TX transfers. * Scans the TX descriptors and frees the buffers of completed TX transfers.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2028,7 +2028,7 @@ static void stm32_freeframe(struct stm32_ethmac_s *priv)
* Description: * Description:
* An interrupt was received indicating that the last TX packet(s) is done * An interrupt was received indicating that the last TX packet(s) is done
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* *
* Returned Value: * Returned Value:
@@ -2071,7 +2071,7 @@ static void stm32_txdone(struct stm32_ethmac_s *priv)
* Description: * Description:
* Perform interrupt related work from the worker thread * Perform interrupt related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() was called. * arg - The argument passed when work_queue() was called.
* *
* Returned Value: * Returned Value:
@@ -2177,7 +2177,7 @@ static void stm32_interrupt_work(void *arg)
* Description: * Description:
* Hardware interrupt handler * Hardware interrupt handler
* *
* Parameters: * Input Parameters:
* irq - Number of the IRQ that generated the interrupt * irq - Number of the IRQ that generated the interrupt
* context - Interrupt register state save info (architecture-specific) * context - Interrupt register state save info (architecture-specific)
* *
@@ -2233,7 +2233,7 @@ static int stm32_interrupt(int irq, void *context, FAR void *arg)
* Description: * Description:
* Perform TX timeout related work from the worker thread * Perform TX timeout related work from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2267,7 +2267,7 @@ static void stm32_txtimeout_work(void *arg)
* Our TX watchdog timed out. Called from the timer interrupt handler. * Our TX watchdog timed out. Called from the timer interrupt handler.
* The last TX never completed. Reset the hardware and start again. * The last TX never completed. Reset the hardware and start again.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2307,7 +2307,7 @@ static void stm32_txtimeout_expiry(int argc, uint32_t arg, ...)
* Description: * Description:
* Perform periodic polling from the worker thread * Perform periodic polling from the worker thread
* *
* Parameters: * Input Parameters:
* arg - The argument passed when work_queue() as called. * arg - The argument passed when work_queue() as called.
* *
* Returned Value: * Returned Value:
@@ -2379,7 +2379,7 @@ static void stm32_poll_work(void *arg)
* Description: * Description:
* Periodic timer handler. Called from the timer interrupt handler. * Periodic timer handler. Called from the timer interrupt handler.
* *
* Parameters: * Input Parameters:
* argc - The number of available arguments * argc - The number of available arguments
* arg - The first argument * arg - The first argument
* *
@@ -2414,7 +2414,7 @@ static void stm32_poll_expiry(int argc, uint32_t arg, ...)
* NuttX Callback: Bring up the Ethernet interface when an IP address is * NuttX Callback: Bring up the Ethernet interface when an IP address is
* provided * provided
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2468,7 +2468,7 @@ static int stm32_ifup(struct net_driver_s *dev)
* Description: * Description:
* NuttX Callback: Stop the interface. * NuttX Callback: Stop the interface.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2515,7 +2515,7 @@ static int stm32_ifdown(struct net_driver_s *dev)
* Description: * Description:
* Perform an out-of-cycle poll on the worker thread. * Perform an out-of-cycle poll on the worker thread.
* *
* Parameters: * Input Parameters:
* arg - Reference to the NuttX driver state structure (cast to void*) * arg - Reference to the NuttX driver state structure (cast to void*)
* *
* Returned Value: * Returned Value:
@@ -2553,7 +2553,7 @@ static void stm32_txavail_work(void *arg)
* stimulus perform an out-of-cycle poll and, thereby, reduce the TX * stimulus perform an out-of-cycle poll and, thereby, reduce the TX
* latency. * latency.
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* *
* Returned Value: * Returned Value:
@@ -2589,7 +2589,7 @@ static int stm32_txavail(struct net_driver_s *dev)
* Description: * Description:
* Function to calculate the CRC used by STM32 to check an ethernet frame * Function to calculate the CRC used by STM32 to check an ethernet frame
* *
* Parameters: * Input Parameters:
* data - the data to be checked * data - the data to be checked
* length - length of the data * length - length of the data
* *
@@ -2634,7 +2634,7 @@ static uint32_t stm32_calcethcrc(const uint8_t *data, size_t length)
* NuttX Callback: Add the specified MAC address to the hardware multicast * NuttX Callback: Add the specified MAC address to the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be added * mac - The MAC address to be added
* *
@@ -2691,7 +2691,7 @@ static int stm32_addmac(struct net_driver_s *dev, const uint8_t *mac)
* NuttX Callback: Remove the specified MAC address from the hardware multicast * NuttX Callback: Remove the specified MAC address from the hardware multicast
* address filtering * address filtering
* *
* Parameters: * Input Parameters:
* dev - Reference to the NuttX driver state structure * dev - Reference to the NuttX driver state structure
* mac - The MAC address to be removed * mac - The MAC address to be removed
* *
@@ -2753,7 +2753,7 @@ static int stm32_rmmac(struct net_driver_s *dev, const uint8_t *mac)
* Description: * Description:
* Initializes the DMA TX descriptors in chain mode. * Initializes the DMA TX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* txtable - List of pre-allocated TX descriptors for the Ethernet * txtable - List of pre-allocated TX descriptors for the Ethernet
* interface * interface
@@ -2845,7 +2845,7 @@ static void stm32_txdescinit(struct stm32_ethmac_s *priv,
* Description: * Description:
* Initializes the DMA RX descriptors in chain mode. * Initializes the DMA RX descriptors in chain mode.
* *
* Parameters: * Input Parameters:
* priv - Reference to the driver state structure * priv - Reference to the driver state structure
* rxtable - List of pre-allocated RX descriptors for the Ethernet * rxtable - List of pre-allocated RX descriptors for the Ethernet
* interface * interface
@@ -2947,7 +2947,7 @@ static void stm32_rxdescinit(struct stm32_ethmac_s *priv,
* is specified using the req->reg_no struct field and use req->val_in as * is specified using the req->reg_no struct field and use req->val_in as
* its input. * its input.
* *
* Parameters: * Input Parameters:
* dev - Ethernet device structure * dev - Ethernet device structure
* cmd - SIOCxMIIxxx command code * cmd - SIOCxMIIxxx command code
* arg - Request structure also used to return values * arg - Request structure also used to return values
@@ -3028,7 +3028,7 @@ static int stm32_ioctl(struct net_driver_s *dev, int cmd, unsigned long arg)
* is received. * is received.
* - Interrupt status is cleared when the interrupt is re-enabled. * - Interrupt status is cleared when the interrupt is re-enabled.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3050,7 +3050,7 @@ static int stm32_phyintenable(struct stm32_ethmac_s *priv)
* Description: * Description:
* Read a PHY register. * Read a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The location to return the 16-bit PHY register value. * value - The location to return the 16-bit PHY register value.
@@ -3105,7 +3105,7 @@ static int stm32_phyread(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t *val
* Description: * Description:
* Write to a PHY register. * Write to a PHY register.
* *
* Parameters: * Input Parameters:
* phydevaddr - The PHY device address * phydevaddr - The PHY device address
* phyregaddr - The PHY register address * phyregaddr - The PHY register address
* value - The 16-bit value to write to the PHY register value. * value - The 16-bit value to write to the PHY register value.
@@ -3168,7 +3168,7 @@ static int stm32_phywrite(uint16_t phydevaddr, uint16_t phyregaddr, uint16_t val
* fundamental issue with the PHY clocking initialization, but the * fundamental issue with the PHY clocking initialization, but the
* root cause has not been studied (nor will it be with this workaround). * root cause has not been studied (nor will it be with this workaround).
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3230,7 +3230,7 @@ static inline int stm32_dm9161(struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the PHY and determine the link speed/duplex. * Configure the PHY and determine the link speed/duplex.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3502,7 +3502,7 @@ static inline void stm32_selectrmii(void)
* Description: * Description:
* Configure GPIOs for the Ethernet interface. * Configure GPIOs for the Ethernet interface.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3655,7 +3655,7 @@ static inline void stm32_ethgpioconfig(struct stm32_ethmac_s *priv)
* Description: * Description:
* Reset the Ethernet block. * Reset the Ethernet block.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3702,7 +3702,7 @@ static void stm32_ethreset(struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet MAC for DMA operation. * Configure the Ethernet MAC for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3785,7 +3785,7 @@ static int stm32_macconfig(struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the selected MAC address. * Configure the selected MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3827,7 +3827,7 @@ static void stm32_macaddress(struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the IPv6 multicast MAC address. * Configure the IPv6 multicast MAC address.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3900,7 +3900,7 @@ static void stm32_ipv6multicast(struct stm32_ethmac_s *priv)
* Description: * Description:
* Enable normal MAC operation. * Enable normal MAC operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -3986,7 +3986,7 @@ static int stm32_macenable(struct stm32_ethmac_s *priv)
* Description: * Description:
* Configure the Ethernet interface for DMA operation. * Configure the Ethernet interface for DMA operation.
* *
* Parameters: * Input Parameters:
* priv - A reference to the private driver state structure * priv - A reference to the private driver state structure
* *
* Returned Value: * Returned Value:
@@ -4061,7 +4061,7 @@ static int stm32_ethconfig(struct stm32_ethmac_s *priv)
* must implement up_netinitialize() and call this function to initialize * must implement up_netinitialize() and call this function to initialize
* the desired interfaces. * the desired interfaces.
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value * intf - In the case where there are multiple EMACs, this value
* identifies which EMAC is to be initialized. * identifies which EMAC is to be initialized.
* *
@@ -4141,7 +4141,7 @@ int stm32_ethinitialize(int intf)
* version of up_netinitialize() that calls stm32_ethinitialize() with * version of up_netinitialize() that calls stm32_ethinitialize() with
* the appropriate interface number. * the appropriate interface number.
* *
* Parameters: * Input Parameters:
* None. * None.
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32f7/stm32_ethernet.h
+2 -2
View File
@@ -68,7 +68,7 @@ extern "C"
* multiple Ethernet controllers, then board specific logic must implement * multiple Ethernet controllers, then board specific logic must implement
* up_netinitialize() and call this function to initialize the desired interfaces. * up_netinitialize() and call this function to initialize the desired interfaces.
* *
* Parameters: * Input Parameters:
* intf - In the case where there are multiple EMACs, this value identifies which * intf - In the case where there are multiple EMACs, this value identifies which
* EMAC is to be initialized. * EMAC is to be initialized.
* *
@@ -93,7 +93,7 @@ int stm32_ethinitialize(int intf);
* logic must provide stm32_phyinitialize(); The STM32 Ethernet driver will call * logic must provide stm32_phyinitialize(); The STM32 Ethernet driver will call
* this function one time before it first uses the PHY. * this function one time before it first uses the PHY.
* *
* Parameters: * Input Parameters:
* intf - Always zero for now. * intf - Always zero for now.
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32f7/stm32_exti_alarm.c
+1 -1
View File
@@ -110,7 +110,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI alarm interrupt. * Sets/clears EXTI alarm interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edget * - rising/falling edge: enables interrupt on rising/falling edget
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32f7/stm32_exti_pwr.c
+1 -1
View File
@@ -117,7 +117,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, void *arg)
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32f7/stm32_exti_pwr.h
+1 -1
View File
@@ -54,7 +54,7 @@
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32f7/stm32_ltdc.c
+49 -49
View File
@@ -1023,7 +1023,7 @@ static void stm32_ltdc_periphconfig(void)
* Description: * Description:
* Configures background color of the LCD controller. * Configures background color of the LCD controller.
* *
* Parameter: * Input Parameters:
* rgb - RGB888 background color * rgb - RGB888 background color
* *
****************************************************************************/ ****************************************************************************/
@@ -1041,7 +1041,7 @@ static void stm32_ltdc_bgcolor(uint32_t rgb)
* Description: * Description:
* Configures dither settings of the LCD controller. * Configures dither settings of the LCD controller.
* *
* Parameter: * Input Parameters:
* enable - Enable dithering * enable - Enable dithering
* red - Red dither width * red - Red dither width
* green - Green dither width * green - Green dither width
@@ -1098,7 +1098,7 @@ static void stm32_ltdc_linepos(void)
* Description: * Description:
* Control interrupts generated by the ltdc controller * Control interrupts generated by the ltdc controller
* *
* Parameter: * Input Parameters:
* setirqs - set interrupt mask * setirqs - set interrupt mask
* clrirqs - clear interrupt mask * clrirqs - clear interrupt mask
* *
@@ -1214,7 +1214,7 @@ static int stm32_ltdc_waitforirq(void)
* Note! The caller must ensure that a previous register reloading has been * Note! The caller must ensure that a previous register reloading has been
* completed. * completed.
* *
* Parameter: * Input Parameters:
* value - Reload flag (e.g. upon vertical blank or immediately) * value - Reload flag (e.g. upon vertical blank or immediately)
* waitvblank - Wait until register reload is finished * waitvblank - Wait until register reload is finished
* *
@@ -1344,7 +1344,7 @@ static void stm32_global_configure(void)
* Description: * Description:
* Disable the LCD peripheral * Disable the LCD peripheral
* *
* Parameter: * Input Parameters:
* enable - Enable or disable * enable - Enable or disable
* *
****************************************************************************/ ****************************************************************************/
@@ -1380,7 +1380,7 @@ static void stm32_lcd_enable(bool enable)
* Description: * Description:
* Disable or enable the layer clut support * Disable or enable the layer clut support
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* enable - Enable or disable * enable - Enable or disable
* *
@@ -1416,7 +1416,7 @@ static void stm32_ltdc_lclutenable(FAR struct stm32_layer_s *layer, bool enable)
* Description: * Description:
* Helper to set the layer to opac * Helper to set the layer to opac
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1432,7 +1432,7 @@ static inline void stm32_ltdc_lsetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to set the layer opacity to the alpha value * Helper to set the layer opacity to the alpha value
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1448,7 +1448,7 @@ static inline void stm32_ltdc_lunsetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to get the configured layer opacity * Helper to get the configured layer opacity
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1464,7 +1464,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Helper to check if the layer is an valid ltdc layer * Helper to check if the layer is an valid ltdc layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
* Returned Value: * Returned Value:
@@ -1488,7 +1488,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer)
* Description: * Description:
* Check if layer coordinates out of valid area. * Check if layer coordinates out of valid area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* xpos - top left x position of the active area * xpos - top left x position of the active area
* ypos - top left y position of the active area * ypos - top left y position of the active area
@@ -1545,7 +1545,7 @@ static int stm32_ltdc_lvalidatearea(FAR struct stm32_layer_s *layer,
* This made changes for the given layer visible after the next shadow * This made changes for the given layer visible after the next shadow
* register reload. * register reload.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1601,7 +1601,7 @@ static void stm32_ltdc_lupdate(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Change the active area of the layer * Change the active area of the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1655,7 +1655,7 @@ static void stm32_ltdc_larea(struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* Reference to the layer control structure * Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1678,7 +1678,7 @@ static void stm32_ltdc_lpixelformat(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* Reference to the layer control structure * Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1725,7 +1725,7 @@ static inline void stm32_ltdc_lframebuffer(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1750,7 +1750,7 @@ static void stm32_ltdc_lalpha(FAR struct stm32_layer_s *layer)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the laxer control structure * layer - Reference to the laxer control structure
* bf1 - Value of blend factor 1 * bf1 - Value of blend factor 1
* bf2 - Value of blend factor 2 * bf2 - Value of blend factor 2
@@ -1778,7 +1778,7 @@ static void stm32_ltdc_lblendmode(FAR struct stm32_layer_s *layer,
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1801,7 +1801,7 @@ static void stm32_ltdc_lcolor(FAR struct stm32_layer_s *layer, uint32_t argb)
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1846,7 +1846,7 @@ static void stm32_ltdc_lcolorkey(FAR struct stm32_layer_s *layer)
* Update the clut layer register during blank period. * Update the clut layer register during blank period.
* Note! The clut register are no shadow register. * Note! The clut register are no shadow register.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1928,7 +1928,7 @@ static void stm32_ltdc_lclut(FAR struct stm32_layer_s *layer,
* Note! This changes have no effect until the shadow register reload has * Note! This changes have no effect until the shadow register reload has
* been done. * been done.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -1964,7 +1964,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer)
* Description: * Description:
* Clear the whole layer * Clear the whole layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* color - The color to clear * color - The color to clear
* *
@@ -2077,7 +2077,7 @@ static void stm32_ltdc_lclear(FAR struct stm32_layer_s *layer,
* - layer blendmode * - layer blendmode
* - layer dma2d interface binding * - layer dma2d interface binding
* *
* Parameter * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* *
****************************************************************************/ ****************************************************************************/
@@ -2178,7 +2178,7 @@ static void stm32_ltdc_linit(int lid)
* Description: * Description:
* Get the videoinfo for the framebuffer * Get the videoinfo for the framebuffer
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* vinfo - the videoinfo object * vinfo - the videoinfo object
* *
@@ -2213,7 +2213,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable,
* Description: * Description:
* Get the planeinfo for the framebuffer * Get the planeinfo for the framebuffer
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* pinfo - the planeinfo object * pinfo - the planeinfo object
* *
@@ -2248,7 +2248,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno,
* Description: * Description:
* Get a range of CLUT values for the LCD * Get a range of CLUT values for the LCD
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* cmap - the color table * cmap - the color table
* *
@@ -2275,7 +2275,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable,
* Description: * Description:
* Set a range of the CLUT values for the LCD * Set a range of the CLUT values for the LCD
* *
* Parameter: * Input Parameters:
* vtable - The framebuffer driver object * vtable - The framebuffer driver object
* cmap - the color table * cmap - the color table
* *
@@ -2302,7 +2302,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable,
* Description: * Description:
* Get video information about the layer * Get video information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* vinfo - Reference to the video info structure * vinfo - Reference to the video info structure
* *
@@ -2335,7 +2335,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer,
* Description: * Description:
* Get plane information about the layer * Get plane information about the layer
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* planeno - Number of the plane * planeno - Number of the plane
* pinfo - Reference to the plane info structure * pinfo - Reference to the plane info structure
@@ -2370,7 +2370,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno,
* Non clut is defined during initializing. * Non clut is defined during initializing.
* Clut is active during next vertical blank period. Do not need an update. * Clut is active during next vertical blank period. Do not need an update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - color lookup table with up the 256 entries * cmap - color lookup table with up the 256 entries
* *
@@ -2429,7 +2429,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer,
* Description: * Description:
* Get configured layer clut (color lookup table). * Get configured layer clut (color lookup table).
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* cmap - Reference to valid color lookup table accept up the 256 color * cmap - Reference to valid color lookup table accept up the 256 color
* entries * entries
@@ -2526,7 +2526,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer,
* Description: * Description:
* Get a specific layer identifier. * Get a specific layer identifier.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* lid - Reference to store the layer id * lid - Reference to store the layer id
* flag - Operation flag describe the layer identifier * flag - Operation flag describe the layer identifier
@@ -2606,7 +2606,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid,
* Default value during initializing: 0x00000000 * Default value during initializing: 0x00000000
* Color is active after next update. * Color is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* argb - ARGB8888 color value * argb - ARGB8888 color value
* *
@@ -2642,7 +2642,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb)
* Description: * Description:
* Get configured layer color for the non active layer area. * Get configured layer color for the non active layer area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* argb - Reference to store the ARGB8888 color value * argb - Reference to store the ARGB8888 color value
* *
@@ -2679,7 +2679,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb)
* Layer default value during initializing: 0x00000000 * Layer default value during initializing: 0x00000000
* Colorkey is active after next update. * Colorkey is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* rgb - RGB888 color value * rgb - RGB888 color value
* *
@@ -2715,7 +2715,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb)
* Description: * Description:
* Get the configured layer color key (chromakey) for transparency. * Get the configured layer color key (chromakey) for transparency.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* rgb - Reference to store the RGB888 color key * rgb - Reference to store the RGB888 color key
* *
@@ -2756,7 +2756,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb)
* Default alpha value during initializing: 0xff * Default alpha value during initializing: 0xff
* Alpha is active after next update. * Alpha is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Alpha value * alpha - Alpha value
* *
@@ -2792,7 +2792,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha)
* Description: * Description:
* Get configured layer alpha value factor for blend operation. * Get configured layer alpha value factor for blend operation.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* alpha - Reference to store the alpha value * alpha - Reference to store the alpha value
* *
@@ -2829,7 +2829,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha)
* Default mode during initializing: LTDC_BLEND_NONE * Default mode during initializing: LTDC_BLEND_NONE
* Blendmode is active after next update. * Blendmode is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Blend mode (see LTDC_BLEND_*) * mode - Blend mode (see LTDC_BLEND_*)
* *
@@ -2961,7 +2961,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode)
* Description: * Description:
* Get configured blend mode of the layer. * Get configured blend mode of the layer.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - Reference to store the blend mode * mode - Reference to store the blend mode
* *
@@ -2998,7 +2998,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode)
* the active area. * the active area.
* Area is active after next update. * Area is active after next update.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* area - Reference to the valid area structure for the new active area * area - Reference to the valid area structure for the new active area
* srcxpos - x position of the visible pixel of the whole layer * srcxpos - x position of the visible pixel of the whole layer
@@ -3060,7 +3060,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer,
* Description: * Description:
* Get configured visible layer area. * Get configured visible layer area.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer control structure * layer - Reference to the layer control structure
* area - Reference to the area structure to store the active area * area - Reference to the area structure to store the active area
* srcxpos - Reference to store the referenced x position of the whole layer * srcxpos - Reference to store the referenced x position of the whole layer
@@ -3102,7 +3102,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer,
* Description: * Description:
* Update current layer settings and make changes visible. * Update current layer settings and make changes visible.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* mode - operation mode * mode - operation mode
* *
@@ -3262,7 +3262,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode)
* Copy selected area from a source layer to selected position of the * Copy selected area from a source layer to selected position of the
* destination layer. * destination layer.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* destxpos - Selected x position of the destination layer * destxpos - Selected x position of the destination layer
* destypos - Selected y position of the destination layer * destypos - Selected y position of the destination layer
@@ -3310,7 +3310,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest,
* of the background layer. Copy the result to the destination layer. Note! * of the background layer. Copy the result to the destination layer. Note!
* The content of the foreground and background layer is not changed. * The content of the foreground and background layer is not changed.
* *
* Parameter: * Input Parameters:
* dest - Reference to the destination layer * dest - Reference to the destination layer
* destxpos - Selected x position of the destination layer * destxpos - Selected x position of the destination layer
* destypos - Selected y position of the destination layer * destypos - Selected y position of the destination layer
@@ -3364,7 +3364,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest,
* Description: * Description:
* Fill the selected area of the whole layer with a specific color. * Fill the selected area of the whole layer with a specific color.
* *
* Parameter: * Input Parameters:
* layer - Reference to the layer structure * layer - Reference to the layer structure
* area - Reference to the valid area structure select the area * area - Reference to the valid area structure select the area
* color - Color to fill the selected area. Color must be formatted * color - Color to fill the selected area. Color must be formatted
@@ -3409,7 +3409,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer,
* Get the specific layer object by the layer id to enable layer hardware * Get the specific layer object by the layer id to enable layer hardware
* support. * support.
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
@@ -3598,7 +3598,7 @@ void stm32_ltdcuninitialize(void)
* entire display can be slow. Here the display is cleared by simply setting * entire display can be slow. Here the display is cleared by simply setting
* all video memory to the specified color. * all video memory to the specified color.
* *
* Parameter: * Input Parameters:
* color - The color the clear the whole framebuffer * color - The color the clear the whole framebuffer
* *
****************************************************************************/ ****************************************************************************/
@@ -3617,7 +3617,7 @@ void stm32_lcdclear(nxgl_mxpixel_t color)
* Description: * Description:
* Provide this interface to turn the backlight on and off. * Provide this interface to turn the backlight on and off.
* *
* Parameter: * Input Parameters:
* blon - Enable or disable the lcd backlight * blon - Enable or disable the lcd backlight
* *
****************************************************************************/ ****************************************************************************/
arch/arm/src/stm32f7/stm32_ltdc.h
+1 -1
View File
@@ -624,7 +624,7 @@ void stm32_ltdcuninitialize(void);
* Description: * Description:
* Get the ltdc layer structure to perform hardware layer operation * Get the ltdc layer structure to perform hardware layer operation
* *
* Parameter: * Input Parameters:
* lid - Layer identifier * lid - Layer identifier
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32l4/stm32l4_comp.c
+2 -2
View File
@@ -304,7 +304,7 @@ static int comp_bind(FAR struct comp_dev_s *dev,
* Description: * Description:
* Enable/disable comparator * Enable/disable comparator
* *
* Parameters: * Input Parameters:
* cmp - comparator * cmp - comparator
* cfg - enable/disable flag * cfg - enable/disable flag
* *
@@ -339,7 +339,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Configure comparator and I/Os used as comparators inputs * Configure comparator and I/Os used as comparators inputs
* *
* Parameters: * Input Parameters:
* cfg - configuration * cfg - configuration
* *
* Returned Value: * Returned Value:
arch/arm/src/stm32l4/stm32l4_exti.h
+3 -3
View File
@@ -95,7 +95,7 @@ int stm32l4_gpiosetevent(uint32_t pinset, bool risingedge, bool fallingedge,
* Description: * Description:
* Sets/clears EXTI alarm interrupt. * Sets/clears EXTI alarm interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edges * - rising/falling edge: enables interrupt on rising/falling edges
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
@@ -118,7 +118,7 @@ int stm32l4_exti_alarm(bool risingedge, bool fallingedge, bool event,
* Description: * Description:
* Sets/clears EXTI wakeup interrupt. * Sets/clears EXTI wakeup interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edges * - rising/falling edge: enables interrupt on rising/falling edges
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
@@ -141,7 +141,7 @@ int stm32l4_exti_wakeup(bool risingedge, bool fallingedge, bool event,
* Description: * Description:
* Sets/clears comparator based events and interrupt triggers. * Sets/clears comparator based events and interrupt triggers.
* *
* Parameters: * Input Parameters:
* - cmp: comparator * - cmp: comparator
* - rising/falling edge: enables interrupt on rising/falling edges * - rising/falling edge: enables interrupt on rising/falling edges
* - event: generate event when set * - event: generate event when set
arch/arm/src/stm32l4/stm32l4_exti_alarm.c
+1 -1
View File
@@ -103,7 +103,7 @@ static int stm32l4_exti_alarm_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI alarm interrupt. * Sets/clears EXTI alarm interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edget * - rising/falling edge: enables interrupt on rising/falling edget
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32l4/stm32l4_exti_comp.c
+1 -1
View File
@@ -122,7 +122,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears comparator based events and interrupt triggers. * Sets/clears comparator based events and interrupt triggers.
* *
* Parameters: * Input Parameters:
* - cmp: comparator * - cmp: comparator
* - rising/falling edge: enables interrupt on rising/falling edget * - rising/falling edge: enables interrupt on rising/falling edget
* - event: generate event when set * - event: generate event when set
arch/arm/src/stm32l4/stm32l4_exti_pwr.c
+1 -1
View File
@@ -108,7 +108,7 @@ static int stm32l4_exti_pvd_isr(int irq, void *context, FAR void *arg)
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt
arch/arm/src/stm32l4/stm32l4_exti_pwr.h
+1 -1
View File
@@ -53,7 +53,7 @@
* Description: * Description:
* Sets/clears EXTI PVD interrupt. * Sets/clears EXTI PVD interrupt.
* *
* Parameters: * Input Parameters:
* - rising/falling edge: enables interrupt on rising/falling edge * - rising/falling edge: enables interrupt on rising/falling edge
* - event: generate event when set * - event: generate event when set
* - func: when non-NULL, generate interrupt * - func: when non-NULL, generate interrupt

Some files were not shown because too many files have changed in this diff Show More