Jean Mercier / Mbed 2 deprecated jmStepper

Control up to 4 steppers from serial port

Dependencies:   mbed

jmRingBuffer.c@0:0785901b085e, 2011-02-12 (annotated)

Committer:
jm
Date:
Sat Feb 12 16:42:08 2011 +0000
Revision:
0:0785901b085e
jmStepper Command Line Interface Module

Who changed what in which revision?

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