Trivial: Style

Signed-off-by: Lucy <[email protected]>

Author: lucypa

libsharedringbuffer/README.md

@@ -16,9 +16,9 @@ memory regions and notification/signalling handlers to this library.
 To use this library in a project you can link `shared_ringbuffer` in your
 target applications CMake configuration.
 
-This libary is intented to be used by both a producer and consumer. For 
+This libary is intended to be used by both a producer and consumer. For 
 example, an ethernet driver produces data for a network stack to consume.
-2 seperate shared memory regions are required for each ring handle; one
+2 separate shared memory regions are required for each ring handle; one
 to store available buffers and one to store used buffers. Each ring buffer
 contains a separate read index and write index. The reader only ever 
 increments the read index, and the writer the write index. As read and 
@@ -36,7 +36,7 @@ This library is intended to be used with a separate shared memory region,
 usually allocated for DMA for a driver. The ring buffers can then contain
 pointers into this shared memory, indicating which buffers are in use or
 available to be used by either component. 
-Typically, 2 shared ring buffers are required, with seperate structures
+Typically, 2 shared ring buffers are required, with separate structures
 required on the recieve path and transmit path. Thus there are 4 regions
 of shared memory required: 1 storing pointers to available RX buffers, 
 1 storing pointers to used RX buffers, 1 storing pointers to TX 

libsharedringbuffer/include/shared_ringbuffer/shared_ringbuffer.h

@@ -22,9 +22,9 @@ typedef struct buff_desc {
 
 /* Circular buffer containing descriptors */
 typedef struct ring_buffer {
-    buff_desc_t buffers[CONFIG_LIB_SHARED_RINGBUFFER_DESC_COUNT]; 
     uint32_t write_idx;
     uint32_t read_idx;
+    buff_desc_t buffers[CONFIG_LIB_SHARED_RINGBUFFER_DESC_COUNT];
 } ring_buffer_t;
 
 /* A ring handle for enqueing/dequeuing into  */

libvirtqueue/README.md

@@ -10,7 +10,7 @@ libvirtqueue
 **_This implementation is currently a work in progress_**
 
 This directory contains a library implementation of a virtqueue inspired from
-the  specification. This is intended to be used as a communication
+the virtio specification. This is intended to be used as a communication
 mechanism between system components for bulk data transfer.
 The goal of this implementation is to provide a generic interface for manipulating
 and managing a 'virtqueue' connection. This library doesn't contain any code that

libvirtqueue/include/virtqueue.h

@@ -188,8 +188,4 @@ int virtqueue_gather_available(virtqueue_device_t *vq, virtqueue_ring_object_t *
  * @return 1 on success, 0 on failure (no more buffer available)
  */
 int virtqueue_gather_used(virtqueue_driver_t *vq, virtqueue_ring_object_t *robj,
-                          void **buf, unsigned *len, vq_flags_t *flag);
-
-int virtqueue_get_num_used();
-void add_rx_used_count();
-void decrement_rx_used_count();
+                          void **buf, unsigned *len, vq_flags_t *flag);

libvirtqueue/src/virtqueue.c

@@ -7,8 +7,6 @@
 #include <utils/util.h>
 #include <virtqueue.h>
 
-int num_used_buffs = 0;
-
 void virtqueue_init_driver(virtqueue_driver_t *vq, unsigned queue_len, vq_vring_avail_t *avail_ring,
                            vq_vring_used_t *used_ring, vq_vring_desc_t *desc, void (*notify)(void),
                            void *cookie)
@@ -218,16 +216,4 @@ int virtqueue_gather_used(virtqueue_driver_t *vq, virtqueue_ring_object_t *robj,
     }
     robj->cur = vq_pop_desc(vq, robj->cur, buf, len, flag);
     return 1;
-}
-
-int virtqueue_get_num_used() {
-    return num_used_buffs;
-}
-
-void add_rx_used_count() {
-    num_used_buffs++;
-}
-
-void decrement_rx_used_count() {
-    num_used_buffs--;
 }