summaryrefslogtreecommitdiff
path: root/i/marvin/src/proto/proto.cc
blob: 4380f071957ea0c7506b46814945d43274f37dc8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
// proto.cc
// robert - programme du robot 2005. {{{
//
// Copyright (C) 2005 Nicolas Haller
//
// Robot APB Team/Efrei 2005.
//        Web: http://assos.efrei.fr/robot/
//      Email: robot AT efrei DOT fr
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}

#include "timer/timer.hh"
#include "utils/hexa.hh"
#include "proto.hh"

#include <iostream>
#include <algorithm>
#include <iterator>

/// Constructeur.
Proto::Proto(Receiver &receiver)
    : log_ ("proto"), receiver_(receiver), tLastSend_(0), revState_(0)
{
}

/// Ouvre le port s�rie.
void
Proto::open(const std::string &ttyname)
{
    serial_.open(ttyname);
}

/// Ferme le port s�rie
void
Proto::close(void)
{
    serial_.close();
}

/// Teste si tout les packets ont �t� envoy�s et aquit�s, sinon, essaye de 
/// le faire.
bool
Proto::sync(void)
{
    // R�cup�ration de la frame
    while (getFrame())
      {
//  	log_ ("recv", Log::debug) << "frame" << currentFrame_;
	// Si la frame est un aquittement
	if(currentFrame_ == frameQueue_.front())
	  {
	    // on vire la commande de la queue
	    frameQueue_.pop();
	    // Et on envoie la suivante si elle existe
	    if(!frameQueue_.empty())
		sendFrame(frameQueue_.front());
	  }
	// Si c'est une nouvelle commande, on l'envoie avec receive
	else
	    receiver_.receive(currentFrame_.command, currentFrame_);
      }
    // On regarde depuis combien de temps on a envoy� une commande
    if(!frameQueue_.empty())
      {
	// Si on d�passe la milliseconde, on renvoie
	if(Timer::getProgramTime() - tLastSend_ >= timeout_)
	    sendFrame(frameQueue_.front());
      }	    
    return frameQueue_.empty();
}

/// Envoie un packet
void
Proto::send (const Frame & frame, bool reliable)
{
    if(reliable)
      {
	if(frameQueue_.empty())
	    tLastSend_ = -timeout_;
	frameQueue_.push(frame);
      }
    else
	sendFrame(frame);
}


/// Envois un packet. COMMAND est la commande � envoyer, FORMAT, donne le
/// format et le nombre de param�tres ('b' : 8 bits, 'w' : 16 bits, 'd' :
/// 32 bits, majuscule pour sign�).
void
Proto::send (char command, const char *format, int a0, int a1,
	     int a2, int a3, int a4, int a5, bool reliable)
{
    // Constitution de la frame
    Proto::Frame frame;
    frame.command = command;

    if (format[0] != '\0')
      {
	newArgFrame(frame, format[0],a0);
	if (format[1] != '\0')
	  {
	    newArgFrame(frame, format[1],a1);
	    if (format[2] != '\0')
	      {
		newArgFrame(frame, format[2],a2);
		if (format[3] != '\0')
		  {
		    newArgFrame(frame, format[3],a3);
		    if(format[4] != '\0')
		      {
			newArgFrame(frame, format[4],a4);
			if(format[5] != '\0')
			    newArgFrame(frame, format[5],a5);
		      }

		  }
	      }
	  }
      }
    send(frame,reliable);
}

/// Send a string of size number.
void
Proto::send (char command, const std::string &str, int size, bool reliable)
{
    Proto::Frame frame;

    for (int compt = 0; compt < size; compt++)
	newArgFrame (frame, 'b', str[compt]);

    send (frame,reliable);
}

/// permet d'envoyer un packet pas fiable
void
Proto::sendUnreliable (char command, const char *format, int a0, int a1,
		       int a2, int a3, int a4, int a5)
{
    send(command, format, a0, a1, a2, a3, a4, a5, false);
}

/// Teste si le packet correspond au format et d�code les valeurs. Utilise
/// le m�me format que send.
bool
Proto::decode (const Proto::Frame &frame)
{
    int dummy;
    return decode(frame, "", dummy, dummy, dummy, dummy, dummy);
}

bool
Proto::decode (const Frame &frame, const char *format, int &a0)
{
    int dummy;
    return decode(frame, format, a0, dummy, dummy, dummy, dummy);
}

bool
Proto::decode (const Frame &frame, const char *format, int &a0, int &a1)
{
    int dummy;
    return decode(frame, format, a0, a1, dummy, dummy, dummy);
}

bool
Proto::decode (const Frame &frame, const char *format, int &a0,
	       int &a1, int &a2)
{
    int dummy;
    return decode(frame, format, a0, a1, a2, dummy, dummy);
}

bool
Proto::decode (const Frame &frame, const char *format, int &a0,
	       int &a1, int &a2, int &a3)
{
    int dummy;
    return decode(frame, format, a0, a1, a2, a3, dummy);
}

bool
Proto::decode (const Frame &frame, const char *format, int &a0,
	       int &a1, int &a2, int &a3, int &a4)
{    
    // Teste si il y a bien le bon nombre d'argument
    if (static_cast<int>(frame.args.size()) != argsFrameSize(format))
	return false; 
    // On d�code et on envoie
    decodeArg(frame, format, a0, a1, a2, a3, a4);

    return true;
}

/// Attend que des caract�res soit disponible pendant un temps maximum en
/// milliseconde et les traite. Renvois le r�sultat de sync (). Attention,
/// fonction bloquante, n'utiliser que pour les tests.
bool
Proto::wait (int timeout/*-1*/)
{
    // On apelle serial_.wait avec un timeout toujours inf ou �gal � proto::timeout_
    serial_.wait (timeout < timeout_ && timeout != -1 ? timeout : timeout_);
    return sync ();
}

/// R�cup�re le File Descriptor
int Proto::getFd(void)
{
    return serial_.getFd();
}

/// R�cup�re les infos de l'AVR pour construire une frame
bool
Proto::getFrame(void)
{
    int receivedChar, d;
    bool erreur = false;
    // tant que le tampon n'est pas vide, on teste
    while((receivedChar = serial_.getchar()) != -1)
      {
	// Si on re�oit un bang
	if(receivedChar == '!')
	  {
	    revState_ = 1;
	    currentFrame_.command = 0;
	    currentFrame_.args.clear();
	  }
	// Si on re�oit le retour chariot et que on re�evait les args
	else if(receivedChar == '\r' && revState_ == 2)
	  {
	    revState_ = 0;
	    return true;
	  }
	// Pour les autres charact�res
	// Si on attend la commande
	else
	    switch(revState_)
	      {
	      case 1:
		if (!isalpha (receivedChar) || receivedChar == '?')
		    erreur = true;
		else
		  {
		    currentFrame_.command = receivedChar;
		    revState_ = 2;
		  }
		break;
	      case 2:
		d = hex2digit (receivedChar);
		if (d == hexInvalid)
		    erreur = true;
		else
		  {
		    currentFrame_.args.push_back (static_cast<uint8_t>(d) << 4);
		    revState_ = 3;
		  }
		break;
	      case 3:
		d = hex2digit (receivedChar);
		if (d == hexInvalid)
		    erreur = true;
		else
		  {
		    currentFrame_.args.back() |= static_cast<uint8_t>(d);
		    revState_ = 2;
		   break;
		  }
	      } 
	      // Si revState == 0 alors on jette
	      // Si on a re�u une erreur on renvoie
	      if(erreur)
	        {
		  // On renvoie en mettant le compteur � 0, la commande sera
		  // renvoyer de retour � sync
// 		  log_("Erreur de reception", Log::debug)
//		  << "commande inconnue" << "";
		  tLastSend_ = 0;
		  revState_ = 0;
		  return false;
	        }
      }
    return false;
}

/// Envoie la frame dans l'AVR
void
Proto::sendFrame(const Frame & frame)
{
//     log_ ("send", Log::debug) << "frame" << frame;
    // envoyer le bang
    serial_.putchar('!');

    // Envoyer la commande
    serial_.putchar(frame.command);

    // Envoyer les arguments
    for(std::vector<uint8_t>::const_iterator it = frame.args.begin();
	it != frame.args.end(); ++it)
      {
	serial_.putchar(digit2hex(*it >> 4));
	serial_.putchar(digit2hex(*it & 0x0f));
      }

    // Envoyer le retour chariot
    serial_.putchar('\r');

    // actualiser le timer
    tLastSend_ = Timer::getProgramTime();
}

/// Remplie une frame avec un argument
void
Proto::newArgFrame(Proto::Frame & frame, char format, int arg)
{
    switch(format)
      {
      case 'b':
      case 'B':
	frame.args.push_back(static_cast<uint8_t>(arg));
	break;
      case 'w':
      case 'W':
	frame.args.push_back(static_cast<uint8_t>(arg >> 8));
	frame.args.push_back(static_cast<uint8_t>(arg));
	break;
      case 'd':
      case 'D':
	frame.args.push_back(static_cast<uint8_t>(arg >> 24));
	frame.args.push_back(static_cast<uint8_t>(arg >> 16));
	frame.args.push_back(static_cast<uint8_t>(arg >> 8));
	frame.args.push_back(static_cast<uint8_t>(arg));
	break;
      }
}

/// Renvoie la taille necessaire du vecteur args pour un format donn�
int
Proto::argsFrameSize(const char *format)
{
    int size = 0;
    for(; *format != '\0'; format++)
	switch(*format)
	  {
	  case 'b':
	  case 'B':
	    size += 1;
	    break;
	  case 'w':
	  case 'W':
	    size += 2;
	    break;
	  case 'd':
	  case 'D':
	    size += 4;
	    break;
	  default:
	    size += 0;
	  }
    return size;
}

/// D�code un argument
void
Proto::decodeArg(const Frame & frame, const char *format, int &a0, int &a1, int &a2, int &a3, int &a4)
{
    int temp[5];
    int pos = 0;

    for(int i = 0; *format != '\0'; format++,i++)
      { 
	switch(*format)
	  {
	  case 'b':
	    temp[i] = static_cast<int>(frame.args[pos]);
	    pos++;
	    break;
	  case 'B':
	      {
		int8_t t = static_cast<int8_t>(frame.args[pos]);
		temp[i] = static_cast<int>(t);
		pos++;
		break;
	      }
	  case 'w':
	    temp[i] = static_cast<int>(frame.args[pos]) << 8 
		|static_cast<int>(frame.args[pos + 1]);
	    pos += 2;
	    break;
	  case 'W':
	      {
		int8_t t = static_cast<int8_t>(frame.args[pos]);
		temp[i] = static_cast<int>(t) << 8
		    |static_cast<int>(frame.args[pos + 1]);
		pos += 2;
		break;
	      }
	  case 'd':
	    temp[i] = static_cast<int>(frame.args[pos]) << 24
		|static_cast<int>(frame.args[pos + 1]) << 16
		|static_cast<int>(frame.args[pos + 2]) << 8
		|static_cast<int>(frame.args[pos + 3]);
	    pos += 4;
	    break;

	  case 'D':
	      {
		int8_t t = static_cast<int8_t>(frame.args[pos]);
		temp[i] = static_cast<int>(t) << 24
		    |static_cast<int>(frame.args[pos + 1]) << 16
		    |static_cast<int>(frame.args[pos + 2]) << 8
		    |static_cast<int>(frame.args[pos + 3]);
		pos += 4;
		break;
	      }
	  }
      }
    a0 = temp[0];
    a1 = temp[1];
    a2 = temp[2];
    a3 = temp[3];
    a4 = temp[4];
}

bool
Proto::Frame::operator==(const Frame& frame)
{
    return this->command == frame.command && this->args == frame.args;
}

/// Affiche une frame.
std::ostream &
operator<< (std::ostream &os, const Proto::Frame &f)
{
    os << '<' << f.command << ' ';
    std::copy (f.args.begin (), f.args.end (),
	       std::ostream_iterator<int> (os, " "));
    os << '>';
    return os;
}