Update some comments.

This commit is contained in:
Gregory Nutt
2018-07-07 11:39:55 -06:00
parent 078fd78af7
commit 6571d4fa37
4 changed files with 41 additions and 3 deletions
+15
View File
@@ -270,6 +270,11 @@ void net_restorelock(unsigned int count)
* Atomically wait for sem (or a timeout( while temporarily releasing
* the lock on the network.
*
* Caution should be utilized. Because the network lock is relinquished
* during the wait, there could changes in the network state that occur
* before the lock is recovered. Your design should account for this
* possibility.
*
* Input Parameters:
* sem - A reference to the semaphore to be taken.
* abstime - The absolute time to wait until a timeout is declared.
@@ -329,6 +334,11 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime)
* Description:
* Atomically wait for sem while temporarily releasing the network lock.
*
* Caution should be utilized. Because the network lock is relinquished
* during the wait, there could changes in the network state that occur
* before the lock is recovered. Your design should account for this
* possibility.
*
* Input Parameters:
* sem - A reference to the semaphore to be taken.
*
@@ -350,6 +360,11 @@ int net_lockedwait(sem_t *sem)
* Allocate an IOB. If no IOBs are available, then atomically wait for
* for the IOB while temporarily releasing the lock on the network.
*
* Caution should be utilized. Because the network lock is relinquished
* during the wait, there could changes in the network state that occur
* before the lock is recovered. Your design should account for this
* possibility.
*
* Input Parameters:
* throttled - An indication of the IOB allocation is "throttled"
*
+1 -1
View File
@@ -288,7 +288,7 @@ uint16_t ipv4_upperlayer_chksum(FAR struct net_driver_s *dev, uint8_t proto);
* Name: ipv6_upperlayer_chksum
*
* Description:
* Perform the checksum calcaultion over the IPv6, protocol headers, and
* Perform the checksum calculation over the IPv6, protocol headers, and
* data payload as necessary.
*
* Input Parameters: