Jean Mercier / Mbed 2 deprecated jmStepperAxis

Control up to 4 steppers axis with limit switch logic from serial port

Dependencies:   mbed

jmRingBuffer.c@0:3e676fcd9c71, 2011-02-12 (annotated)

Committer:
jm
Date:
Sat Feb 12 16:49:03 2011 +0000
Revision:
0:3e676fcd9c71
jmStepperAxis Command Line Interface Module

Who changed what in which revision?

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