Changes in uspace/drv/char/i8042/buffer.h [65ffec3:2df6f6fe] in mainline

File:

• uspace/drv/char/i8042/buffer.h (modified) (5 diffs)

uspace/drv/char/i8042/buffer.h

@@ -26 +26 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+
 /**
  * @addtogroup kbd
  * @{
  */
+
 /** @file
  * @brief Cyclic buffer structure.
@@ -46 +48 @@
  * Attempt to insert byte into the full buffer will block until it can succeed.
  * Attempt to read from empty buffer will block until it can succeed.
+ *
  */
 typedef struct {
-        uint8_t *buffer;         /**< Storage space. */
-        uint8_t *buffer_end;     /**< End of storage place. */
-        fibril_mutex_t guard;    /**< Protects buffer structures. */
-        fibril_condvar_t change; /**< Indicates change (empty/full). */
-        uint8_t *read_head;      /**< Place of the next readable element. */
-        uint8_t *write_head;     /**< Pointer to the next writable place. */
+        uint8_t *buffer;          /**< Storage space. */
+        uint8_t *buffer_end;      /**< End of storage place. */
+        fibril_mutex_t guard;     /**< Protects buffer structures. */
+        fibril_condvar_t change;  /**< Indicates change (empty/full). */
+        uint8_t *read_head;       /**< Place of the next readable element. */
+        uint8_t *write_head;      /**< Pointer to the next writable place. */
 } buffer_t;
 
 /** Initialize cyclic buffer using provided memory space.
+ *
  * @param buffer Cyclic buffer structure to initialize.
- * @param data Memory space to use.
- * @param size Size of the memory place.
+ * @param data   Memory space to use.
+ * @param size   Size of the memory place.
+ *
  */
 static inline void buffer_init(buffer_t *buffer, uint8_t *data, size_t size)
 {
         assert(buffer);
+        
         fibril_mutex_initialize(&buffer->guard);
         fibril_condvar_initialize(&buffer->change);
@@ -74 +80 @@
 
 /** Write byte to cyclic buffer.
+ *
  * @param buffer Cyclic buffer to write to.
- * @param data Data to write.
+ * @param data   Data to write.
+ *
  */
 static inline void buffer_write(buffer_t *buffer, uint8_t data)
 {
         fibril_mutex_lock(&buffer->guard);
-
+        
         /* Next position. */
         uint8_t *new_head = buffer->write_head + 1;
         if (new_head == buffer->buffer_end)
                 new_head = buffer->buffer;
-
+        
         /* Buffer full. */
         while (new_head == buffer->read_head)
                 fibril_condvar_wait(&buffer->change, &buffer->guard);
-
+        
         /* Write data. */
         *buffer->write_head = data;
-
+        
         /* Buffer was empty. */
         if (buffer->write_head == buffer->read_head)
                 fibril_condvar_broadcast(&buffer->change);
-
+        
         /* Move head */
         buffer->write_head = new_head;
@@ -103 +111 @@
 
 /** Read byte from cyclic buffer.
+ *
  * @param buffer Cyclic buffer to read from.
+ *
  * @return Byte read.
+ *
  */
 static inline uint8_t buffer_read(buffer_t *buffer)
 {
         fibril_mutex_lock(&buffer->guard);
+        
         /* Buffer is empty. */
         while (buffer->write_head == buffer->read_head)
                 fibril_condvar_wait(&buffer->change, &buffer->guard);
-
+        
         /* Next position. */
         uint8_t *new_head = buffer->read_head + 1;
         if (new_head == buffer->buffer_end)
                 new_head = buffer->buffer;
-
+        
         /* Read data. */
         const uint8_t data = *buffer->read_head;
-
+        
         /* Buffer was full. */
         uint8_t *new_write_head = buffer->write_head + 1;
@@ -127 +139 @@
         if (new_write_head == buffer->read_head)
                 fibril_condvar_broadcast(&buffer->change);
-
+        
         /* Move head */
         buffer->read_head = new_head;
-
+        
         fibril_mutex_unlock(&buffer->guard);
         return data;
 }
+
 #endif
+
 /**
  * @}