Jean Mercier / Mbed 2 deprecated jmBridge

2 bit Bridge Driver

jmRingBuffer.c@0:bfa30f27fe9d, 2011-02-19 (annotated)

Committer:
jm
Date:
Sat Feb 19 01:30:54 2011 +0000
Revision:
0:bfa30f27fe9d
jmBridge Module

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jm 0:bfa30f27fe9d 1 /*************************************************************************
jm 0:bfa30f27fe9d 2 * @file jmRingBuffer.c
jm 0:bfa30f27fe9d 3 * @brief Command Line Rx Ring Buffer
jm 0:bfa30f27fe9d 4 *
jm 0:bfa30f27fe9d 5 * @date Feb 12, 2011
jm 0:bfa30f27fe9d 6 */
jm 0:bfa30f27fe9d 7
jm 0:bfa30f27fe9d 8
jm 0:bfa30f27fe9d 9 #include "jmRingBuffer.h"
jm 0:bfa30f27fe9d 10 #include "stdio.h"
jm 0:bfa30f27fe9d 11
jm 0:bfa30f27fe9d 12 // static creation of Command Line Buffer
jm 0:bfa30f27fe9d 13 struct RingBuffer Line, *pLine;
jm 0:bfa30f27fe9d 14
jm 0:bfa30f27fe9d 15 /** @brief Command line ring buffer initialization.
jm 0:bfa30f27fe9d 16 * @param none
jm 0:bfa30f27fe9d 17 * @returns none
jm 0:bfa30f27fe9d 18 */
jm 0:bfa30f27fe9d 19 void InitCommandLineRingBuffer(void){
jm 0:bfa30f27fe9d 20 pLine = &Line;
jm 0:bfa30f27fe9d 21 FlushRingBuffer(pLine);
jm 0:bfa30f27fe9d 22 }
jm 0:bfa30f27fe9d 23
jm 0:bfa30f27fe9d 24 /** @brief Move ring head pointer foward.
jm 0:bfa30f27fe9d 25 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 26 * @returns none
jm 0:bfa30f27fe9d 27 */
jm 0:bfa30f27fe9d 28 void NextHead(struct RingBuffer *p)
jm 0:bfa30f27fe9d 29 { p->head++;
jm 0:bfa30f27fe9d 30 if(p->head >= DimRingBuffer)
jm 0:bfa30f27fe9d 31 p->head=0;
jm 0:bfa30f27fe9d 32 }
jm 0:bfa30f27fe9d 33
jm 0:bfa30f27fe9d 34 /** @brief Move ring tail pointer foward.
jm 0:bfa30f27fe9d 35 * @param pointer to ring buffer
jm 0:bfa30f27fe9d 36 * @returns none
jm 0:bfa30f27fe9d 37 */
jm 0:bfa30f27fe9d 38 void NextTail(struct RingBuffer *p)
jm 0:bfa30f27fe9d 39 { p->tail++;
jm 0:bfa30f27fe9d 40 if(p->tail >= DimRingBuffer)
jm 0:bfa30f27fe9d 41 p->tail=0;
jm 0:bfa30f27fe9d 42 }
jm 0:bfa30f27fe9d 43
jm 0:bfa30f27fe9d 44 /** @brief Check if buffer full.
jm 0:bfa30f27fe9d 45 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 46 * @returns true if full, false otherwise
jm 0:bfa30f27fe9d 47 */
jm 0:bfa30f27fe9d 48 bool Full(struct RingBuffer *p)
jm 0:bfa30f27fe9d 49 { if(p->qty >= DimRingBuffer)
jm 0:bfa30f27fe9d 50 return true;
jm 0:bfa30f27fe9d 51 else
jm 0:bfa30f27fe9d 52 return false;
jm 0:bfa30f27fe9d 53 }
jm 0:bfa30f27fe9d 54
jm 0:bfa30f27fe9d 55 /** @brief Insert a char in buffer.
jm 0:bfa30f27fe9d 56 * @param c unsigned char to be inserted
jm 0:bfa30f27fe9d 57 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 58 * @returns none
jm 0:bfa30f27fe9d 59 */
jm 0:bfa30f27fe9d 60 void Insert(unsigned char c, struct RingBuffer *p)
jm 0:bfa30f27fe9d 61 { if(Full(p))
jm 0:bfa30f27fe9d 62 NextHead(p);
jm 0:bfa30f27fe9d 63 else
jm 0:bfa30f27fe9d 64 p->qty++;
jm 0:bfa30f27fe9d 65
jm 0:bfa30f27fe9d 66 p->Buffer[p->tail]=c;
jm 0:bfa30f27fe9d 67 NextTail(p);
jm 0:bfa30f27fe9d 68 }
jm 0:bfa30f27fe9d 69
jm 0:bfa30f27fe9d 70 /** @brief Check if ring buffer not empty.
jm 0:bfa30f27fe9d 71 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 72 * @returns true if full, false otherwise
jm 0:bfa30f27fe9d 73 */
jm 0:bfa30f27fe9d 74 bool NotEmpty(struct RingBuffer *p)
jm 0:bfa30f27fe9d 75 { if(p->qty == 0)
jm 0:bfa30f27fe9d 76 return false ;
jm 0:bfa30f27fe9d 77 else
jm 0:bfa30f27fe9d 78 return true;
jm 0:bfa30f27fe9d 79 }
jm 0:bfa30f27fe9d 80
jm 0:bfa30f27fe9d 81 /** @brief Extract a char from ring buffer.
jm 0:bfa30f27fe9d 82 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 83 * @returns unsigned char
jm 0:bfa30f27fe9d 84 */
jm 0:bfa30f27fe9d 85 unsigned char Extract(struct RingBuffer *p)
jm 0:bfa30f27fe9d 86 { unsigned char c;
jm 0:bfa30f27fe9d 87 c = p->Buffer[p->head];
jm 0:bfa30f27fe9d 88 if(NotEmpty(p))
jm 0:bfa30f27fe9d 89 { NextHead(p);
jm 0:bfa30f27fe9d 90 p->qty--;
jm 0:bfa30f27fe9d 91 }
jm 0:bfa30f27fe9d 92 return c;
jm 0:bfa30f27fe9d 93 }
jm 0:bfa30f27fe9d 94
jm 0:bfa30f27fe9d 95 /** @brief Flush ring buffer.
jm 0:bfa30f27fe9d 96 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 97 * @returns none
jm 0:bfa30f27fe9d 98 */
jm 0:bfa30f27fe9d 99 void FlushRingBuffer(struct RingBuffer *p)
jm 0:bfa30f27fe9d 100 { int i;
jm 0:bfa30f27fe9d 101 p->head = 0;
jm 0:bfa30f27fe9d 102 p->tail = 0;
jm 0:bfa30f27fe9d 103 p->qty = 0;
jm 0:bfa30f27fe9d 104 for(i=0;i<DimRingBuffer;i++)p->Buffer[i]=0;
jm 0:bfa30f27fe9d 105 }
jm 0:bfa30f27fe9d 106
jm 0:bfa30f27fe9d 107 /** @brief Delete last char from ring buffer.
jm 0:bfa30f27fe9d 108 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 109 * @returns none
jm 0:bfa30f27fe9d 110 */
jm 0:bfa30f27fe9d 111 void DelChar(struct RingBuffer *p)
jm 0:bfa30f27fe9d 112 { if(p->qty != 0){
jm 0:bfa30f27fe9d 113 if(p->tail==0)p->tail=DimRingBuffer;
jm 0:bfa30f27fe9d 114 else p->tail--;
jm 0:bfa30f27fe9d 115 p->qty--;
jm 0:bfa30f27fe9d 116 }
jm 0:bfa30f27fe9d 117 }
jm 0:bfa30f27fe9d 118
jm 0:bfa30f27fe9d 119 /** @brief Remove a command line from ring buffer.
jm 0:bfa30f27fe9d 120 * @param c end command identifier unsigned char
jm 0:bfa30f27fe9d 121 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 122 * @returns none
jm 0:bfa30f27fe9d 123 */
jm 0:bfa30f27fe9d 124 void NextCommand(unsigned char c, struct RingBuffer *p){
jm 0:bfa30f27fe9d 125 // remove all char till end identifier is found
jm 0:bfa30f27fe9d 126 while(NotEmpty(p) && p->Buffer[p->head] != c)
jm 0:bfa30f27fe9d 127 { NextHead(p);
jm 0:bfa30f27fe9d 128 p->qty--;
jm 0:bfa30f27fe9d 129 }
jm 0:bfa30f27fe9d 130
jm 0:bfa30f27fe9d 131 // remove end identifier
jm 0:bfa30f27fe9d 132 if(NotEmpty(p)&& p->Buffer[p->head] == c)
jm 0:bfa30f27fe9d 133 { NextHead(p);
jm 0:bfa30f27fe9d 134 p->qty--;
jm 0:bfa30f27fe9d 135 }
jm 0:bfa30f27fe9d 136 }
jm 0:bfa30f27fe9d 137
jm 0:bfa30f27fe9d 138 /** @brief View ring buffer content.
jm 0:bfa30f27fe9d 139 * Print ring buffer content
jm 0:bfa30f27fe9d 140 * @param *p pointer to ring buffer
jm 0:bfa30f27fe9d 141 * @returns none
jm 0:bfa30f27fe9d 142 */
jm 0:bfa30f27fe9d 143 void ViewRingBuffer(struct RingBuffer *p){
jm 0:bfa30f27fe9d 144 int i,j;
jm 0:bfa30f27fe9d 145
jm 0:bfa30f27fe9d 146 printf("\nRingBuffer Qty: %d \nContent: ",p->qty);
jm 0:bfa30f27fe9d 147
jm 0:bfa30f27fe9d 148 for(j=0,i=p->head;j<p->qty;j++){
jm 0:bfa30f27fe9d 149 printf("%c",p->Buffer[i]);
jm 0:bfa30f27fe9d 150 if(i++>DimRingBuffer)i=0;
jm 0:bfa30f27fe9d 151 }
jm 0:bfa30f27fe9d 152 printf("\n");
jm 0:bfa30f27fe9d 153 }
jm 0:bfa30f27fe9d 154
jm 0:bfa30f27fe9d 155 /** @brief Extract a word from ring buffer.
jm 0:bfa30f27fe9d 156 * The extracted word is put in the array pointed by word
jm 0:bfa30f27fe9d 157 * @param p pointer to a ring buffer
jm 0:bfa30f27fe9d 158 * @param word pointer to array of char
jm 0:bfa30f27fe9d 159 * @returns true if a word is extracted otherwise returns false
jm 0:bfa30f27fe9d 160 */
jm 0:bfa30f27fe9d 161 bool ExtractWord(struct RingBuffer *p, char * word){
jm 0:bfa30f27fe9d 162 unsigned char c;
jm 0:bfa30f27fe9d 163 int i,j;
jm 0:bfa30f27fe9d 164 j=0;
jm 0:bfa30f27fe9d 165
jm 0:bfa30f27fe9d 166 if(NotEmpty(p)){
jm 0:bfa30f27fe9d 167 for(i=0;i<WordMaxSize-1;i++){
jm 0:bfa30f27fe9d 168 // extract a char from Rx ring buffer
jm 0:bfa30f27fe9d 169 c=Extract(p);
jm 0:bfa30f27fe9d 170
jm 0:bfa30f27fe9d 171 // remove leading blanks
jm 0:bfa30f27fe9d 172 if(c==' ' && j==0)continue;
jm 0:bfa30f27fe9d 173
jm 0:bfa30f27fe9d 174 // end of word or end of command line
jm 0:bfa30f27fe9d 175 if(c==' ' || c==nl)break;
jm 0:bfa30f27fe9d 176
jm 0:bfa30f27fe9d 177 // build the Word
jm 0:bfa30f27fe9d 178 word[j++]=c;
jm 0:bfa30f27fe9d 179 }
jm 0:bfa30f27fe9d 180 // 0 string termination
jm 0:bfa30f27fe9d 181 word[j]=0;
jm 0:bfa30f27fe9d 182 if(j>0)return true;
jm 0:bfa30f27fe9d 183 }
jm 0:bfa30f27fe9d 184 return false;
jm 0:bfa30f27fe9d 185 }
jm 0:bfa30f27fe9d 186
jm 0:bfa30f27fe9d 187 /** @brief Extract an unsigned int from ring buffer.
jm 0:bfa30f27fe9d 188 * Convert a word from buffer into an integer between min and max values
jm 0:bfa30f27fe9d 189 * Value converted should be between min and max values.
jm 0:bfa30f27fe9d 190 * Value should be decimal or hexadecimal (beginning by 0x or 0X)
jm 0:bfa30f27fe9d 191 * @param p pointer to ring buffer
jm 0:bfa30f27fe9d 192 * @param result pointer to unsigned int
jm 0:bfa30f27fe9d 193 * @param min minimum limit
jm 0:bfa30f27fe9d 194 * @param max maximum limit
jm 0:bfa30f27fe9d 195 * @returns true if value is converted beetween limits, including limits.
jm 0:bfa30f27fe9d 196 */
jm 0:bfa30f27fe9d 197 bool ExtractUInteger(struct RingBuffer *p, unsigned int *result, unsigned int min, unsigned int max){
jm 0:bfa30f27fe9d 198 unsigned int i ;
jm 0:bfa30f27fe9d 199 char word[WordMaxSize-1];
jm 0:bfa30f27fe9d 200
jm 0:bfa30f27fe9d 201 if(ExtractWord(p,word)){ // Extract string value
jm 0:bfa30f27fe9d 202 if(word[0]=='0' && (word[1]=='x' || word[1]=='X')) {
jm 0:bfa30f27fe9d 203 sscanf(word,"%x",&i); // convert hexadecimal input
jm 0:bfa30f27fe9d 204 }
jm 0:bfa30f27fe9d 205 else
jm 0:bfa30f27fe9d 206 sscanf(word,"%d",&i); // convert decimal input
jm 0:bfa30f27fe9d 207
jm 0:bfa30f27fe9d 208 if(i>=min && i<=max){
jm 0:bfa30f27fe9d 209 *result = i;
jm 0:bfa30f27fe9d 210 return true;
jm 0:bfa30f27fe9d 211 }
jm 0:bfa30f27fe9d 212 }
jm 0:bfa30f27fe9d 213 *result = 0;
jm 0:bfa30f27fe9d 214 return false;
jm 0:bfa30f27fe9d 215 }