git.sur5r.net Git - freertos/blob - Demo/CORTEX_STM32F103_GCC_Rowley/Drivers/CircularBuffer.h

   1 /*\r
   2     FreeRTOS V6.0.5 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public \r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it \r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 #ifndef CIRCULAR_BUFFER_H\r
  55 #define CIRCULAR_BUFFER_H\r
  56 \r
  57 /* Structure that holds the state of the circular buffer. */\r
  58 typedef struct\r
  59 {\r
  60         unsigned char *pucDataBuffer;\r
  61         unsigned long ulBufferSizeInBytes;\r
  62         unsigned char *pucNextByteToRead;\r
  63         unsigned char *pucNextByteToWrite;\r
  64         unsigned long ulDataSizeInBytes;\r
  65         void *pvTag;\r
  66 } xCircularBuffer;\r
  67 \r
  68 \r
  69 /*\r
  70  * Setup a circular buffer ready for use.\r
  71  *\r
  72  * pxBuffer : The xCicularBuffer structure being initialised.\r
  73  *\r
  74  * pucDataBuffer : The buffer to be used by the xCicularBuffer object.\r
  75  *\r
  76  * ulBufferSizeInBytes : The dimention of pucDataBuffer in bytes.\r
  77  *\r
  78  * ulDataSizeInBytes : The size of the data that is to be stored in the\r
  79  *              circular buffer.  For example, 4 if the buffer is used to hold\r
  80  *              unsigned longs, 1 if the buffer is used to hold chars.\r
  81  *\r
  82  * pvTag : Can be used for anything, although normally used in conjunction with\r
  83  *         a DMA register.\r
  84  */\r
  85 void vInitialiseCircularBuffer( xCircularBuffer *pxBuffer,\r
  86                                                                 unsigned char *pucDataBuffer,\r
  87                                                                 unsigned long ulBufferSizeInBytes,\r
  88                                                                 unsigned long ulDataSizeInBytes,\r
  89                                                                 void *pvTag\r
  90                                                           );\r
  91 /*\r
  92  * Returns the number of bytes that are currently available within the\r
  93  * buffer.\r
  94  */\r
  95 unsigned long ulBytesInCircularBuffer( const xCircularBuffer * const pxBuffer );\r
  96 \r
  97 /*\r
  98  * Obtain bytes from the circular buffer.  Data may have been placed in\r
  99  * the circular buffer by a DMA transfer or simply written to the buffer by\r
 100  * the application code.\r
 101  *\r
 102  * pxBuffer : The circular buffer from which data is to be read.\r
 103  *\r
 104  * pucBuffer : The buffer into which the received bytes should be copied.\r
 105  *\r
 106  * ulWantedBytes : The number of bytes we are going to attempt to receive\r
 107  *              from the circular buffer.\r
 108  *\r
 109  * return : The actual number of bytes received from the circular buffer.\r
 110  *              This might be less than the number of bytes we attempted to receive.\r
 111  */\r
 112 unsigned long ulCopyReceivedBytes( xCircularBuffer *pxBuffer, unsigned char * pucBuffer, unsigned long ulWantedBytes );\r
 113 \r
 114 #endif\r
 115 \r