01551a68d2a7529e2521a29d85e253854dbba688
[protos/imu.git] / gps_venus.c
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <stdint.h>
4 #include <string.h>
5
6 #include <aversive.h>
7 #include <aversive/endian.h>
8 #include <aversive/wait.h>
9 #include <callout.h>
10 #include <uart.h>
11
12 #include "main.h"
13 #include "gps_venus.h"
14 #include "fat.h"
15 #include "fat_config.h"
16 #include "partition.h"
17 #include "sd_raw.h"
18 #include "sd_raw_config.h"
19 #include "sd_log.h"
20
21 #define debug_printf(args...) do { } while (0)
22 /* #define debug_printf(args...) printf(args) */
23
24 #define GPS_UART 0
25
26 /*
27   https://code.google.com/p/hardware-ntp/source/browse/trunk/pcb-1/venus634.c?r=12
28  */
29
30 /* some useful defines */
31 #define START1 0xA0
32 #define START2 0xA1
33 #define END1 0x0D
34 #define END2 0x0A
35
36 /* proccessing states */
37
38 #define S_RESET 0
39 #define S_POSTRESET 1
40 #define S_START1 2
41 #define S_START2 3
42 #define S_LENGTH1 4
43 #define S_LENGTH2 5
44 #define S_DISCARD 6
45 #define S_COPY 7
46 #define S_ENDCOPY 8
47 #define S_END 9
48 #define S_END1 10
49
50 #define MAX_LEN 0x200
51 struct gps_frame {
52         uint16_t len;
53         uint16_t cur_len;
54         uint8_t data[MAX_LEN];
55 };
56
57 static struct gps_frame rxframe;
58
59 static struct gps_pos gps_pos;
60
61 static struct callout gps_timer;
62
63 /* INPUT FORMATS */
64
65 /* packet types */
66 /* 0x01 - System Restart */
67 #define M_RESTART 0x01
68 typedef struct {
69         uint8_t start_mode; /* 01 = Hot; 02 = Warm; 03 = Cold */
70         uint16_t utc_year; /* >= 1980 */
71         uint8_t utc_month;
72         uint8_t utc_day;
73         uint8_t utc_hour;
74         uint8_t utc_minute;
75         uint8_t utc_second;
76         int16_t latitude; /* -9000 to 9000, 1/100th degree, positive north */
77         int16_t longitude; /* -18000 to 18000, 1/100th degree, positive east */
78         int16_t altitude; /* -1000 to 18300, meters */
79 } m_restart_t;
80
81
82 /* 0x02 - Query Software Version */
83 #define M_QUERYVER 0x02
84 typedef struct {
85         uint8_t software_type; /* 01 = System Code */
86 } m_queryver_t;
87
88
89 /* 0x05 - Serial Port Configuration */
90 #define M_SERCONF 0x05
91 typedef struct {
92         uint8_t port; /* 00 = COM1 (the only port) */
93         uint8_t baud; /* 00 = 4800; 01 = 9600; 02 = 19200; 03 = 38400;
94                          04 = 57600; 05 = 115200; */
95         uint8_t update; /* 00 = SRAM only; 01 = SRAM and FLASH */
96 } m_serconf_t;
97
98
99
100 /* 0x08 - nema interval */
101 #define M_NEMAINTERVAL 0x08
102 typedef struct {
103         uint8_t gga;
104         uint8_t gsa;
105         uint8_t gsv;
106         uint8_t gll;
107         uint8_t rmc;
108         uint8_t vtg;
109         uint8_t zda;
110         uint8_t attributes; /*
111                               0 - sram
112                               1 - flash
113                              */
114
115 } m_nemainterval_t;
116
117
118 /* 0x09 - Query Software Version */
119 #define M_OUTPUT 0x09
120 typedef struct {
121         uint8_t msg_type; /*
122                             00 = no output
123                             01 = nema output
124                             02 = binary output
125                            */
126 } m_output_t;
127
128
129 /* 0x0E - Update Rage */
130 #define M_RATE 0x0E
131 typedef struct {
132         uint8_t rate; /* Hz */
133         uint8_t attributes; /*
134                               0 - update ram
135                               1 - update ram & flash
136                             */
137 } m_rate_t;
138
139
140
141 /* 0x37 - configure waas */
142 #define M_WAAS 0x37
143 typedef struct {
144         uint8_t enable; /* 01 = enable */
145         uint8_t attributes;
146 } m_waas_t;
147
148 /* 0x3C - nav mode */
149 #define M_NAVMODE 0x3c
150 typedef struct {
151         uint8_t navmode; /* 00 = car
152                              01 = pedestrian
153                            */
154         uint8_t attributes;
155 } m_navmode_t;
156
157
158 #define DBG_SEND
159 #define DBG_RECV
160
161 void serial1_tx_cout(uint8_t c)
162 {
163         debug_printf("%.2X ", c);
164         uart_send(GPS_UART, c);
165 }
166
167 void venus634_send(uint8_t type, void *payload, uint16_t len)
168 {
169         uint8_t crc = 0, n;
170
171         debug_printf("SEND ");
172
173         /* now send the message */
174         /* header */
175         serial1_tx_cout(START1);
176         serial1_tx_cout(START2);
177         serial1_tx_cout(((len+1) >> 8) & 0xff);
178         serial1_tx_cout((len+1) & 0xff);
179         /* type and payload */
180         serial1_tx_cout(type);
181         crc ^= type;
182         for (n = 0; n < len; n++) {
183                 serial1_tx_cout(*(uint8_t *)payload);
184                 crc ^= *(uint8_t *)payload;
185                 payload++;
186         }
187         /* checksum and tail */
188         serial1_tx_cout(crc);
189         serial1_tx_cout(END1);
190         serial1_tx_cout(END2);
191
192         debug_printf("\n");
193 }
194
195 void venus634_restart(void)
196 {
197         m_restart_t restart;
198
199         memset(&restart,0,sizeof(m_restart_t));
200         restart.start_mode = 0x03; /* COLD */
201
202         venus634_send(M_RESTART,&restart,sizeof(m_restart_t));
203
204         return;
205 }
206
207 void venus634_config_serial(void)
208 {
209         m_serconf_t serconf;
210
211         memset(&serconf,0,sizeof(m_serconf_t));
212         serconf.port = 0;
213         serconf.baud = 4;
214         serconf.update = 1;
215
216         venus634_send(M_SERCONF,&serconf,sizeof(m_serconf_t));
217
218         return;
219 }
220
221
222 void venus634_msg_type(void)
223 {
224         m_output_t output;
225
226         memset(&output,0,sizeof(m_output_t));
227         output.msg_type = 0x02; /* binary msg */
228
229         venus634_send(M_OUTPUT,&output,sizeof(m_output_t));
230
231         return;
232 }
233
234
235 void venus634_rate(void)
236 {
237         m_rate_t rate;
238
239         memset(&rate,0,sizeof(m_rate_t));
240         rate.rate = 20;
241         //rate.rate = 0; /* ram */
242
243         venus634_send(M_RATE,&rate,sizeof(m_rate_t));
244
245         return;
246 }
247
248 void venus634_waas(void)
249 {
250         m_waas_t waas;
251
252         memset(&waas,0,sizeof(m_waas_t));
253         waas.enable = 1;
254         waas.attributes = 0; /* ram */
255
256         venus634_send(M_WAAS,&waas,sizeof(m_waas_t));
257
258         return;
259 }
260
261
262 void venus634_navmode(void)
263 {
264         m_navmode_t navmode;
265
266         memset(&navmode,0,sizeof(m_navmode_t));
267         navmode.navmode = 0; /* car */
268         navmode.attributes = 0; /* ram */
269
270         venus634_send(M_NAVMODE,&navmode,sizeof(m_navmode_t));
271
272         return;
273 }
274
275
276 void venus634_nema_interval(void)
277 {
278         m_nemainterval_t nemainterval;
279
280         memset(&nemainterval,0,sizeof(m_nemainterval_t));
281         nemainterval.gga = 1;
282         nemainterval.gsa = 1;
283         nemainterval.gsv = 1;
284         nemainterval.gll = 1;
285         nemainterval.rmc = 1;
286         nemainterval.vtg = 1;
287         nemainterval.zda = 1;
288
289         nemainterval.attributes = 1; /* ram flash */
290
291         venus634_send(M_NEMAINTERVAL,&nemainterval,sizeof(m_nemainterval_t));
292
293         return;
294 }
295
296 int8_t recv_cb(uint8_t byte)
297 {
298         uint16_t i;
299
300         /* bytes 0 and 1 are start bytes */
301         if (rxframe.cur_len == 0) {
302                 if (byte != START1) {
303                         debug_printf("bad start1 %.2X\n", byte);
304                         goto reset_buf;
305                 }
306         }
307         else if (rxframe.cur_len == 1) {
308                 if (byte != START2) {
309                         debug_printf("bad start2 %.2X\n", byte);
310                         goto reset_buf;
311                 }
312         }
313         /* bytes 2 and 3 are the length of frame in network order */
314         else if (rxframe.cur_len == 2) {
315                 rxframe.len = (uint16_t)byte << 8;
316         }
317         else if (rxframe.cur_len == 3) {
318                 rxframe.len |= (uint16_t)byte;
319                 if (rxframe.len > MAX_LEN) {
320                         debug_printf("bad len %d\n", rxframe.len);
321                         goto reset_buf;
322                 }
323         }
324         /* next bytes are data (the 4 below is the size of header) */
325         else if ((rxframe.cur_len - 4) < rxframe.len) {
326                 rxframe.data[rxframe.cur_len - 4] = byte;
327         }
328         /* then it's the crc */
329         else if ((rxframe.cur_len - 4) == rxframe.len) {
330                 uint8_t crc = 0;
331
332                 for (i = 0; i < rxframe.len; i++)
333                         crc ^= rxframe.data[i];
334                 if (byte != crc) {
335                         debug_printf("invalid crc\n");
336                         goto reset_buf;
337                 }
338
339         }
340         /* and the last 2 bytes are stop bytes */
341         else if ((rxframe.cur_len - 4) == (rxframe.len + 1)) {
342                 if (byte != END1) {
343                         debug_printf("bad end1 %.2X\n", byte);
344                         goto reset_buf;
345                 }
346         }
347         else if ((rxframe.cur_len - 4) == (rxframe.len + 2)) {
348                 if (byte != END2) {
349                         debug_printf("bad end2 %.2X\n", byte);
350                         goto reset_buf;
351                 }
352                 debug_printf("valid frame received\n");
353                 rxframe.cur_len = 0;
354                 return 0;
355         }
356         else /* should not happen */
357                 goto reset_buf;
358
359         rxframe.cur_len ++;
360         return 1;
361
362  reset_buf:
363         rxframe.cur_len = 0;
364         return 1;
365 }
366
367 int recv_msg(void)
368 {
369         int ret;
370         int16_t c;
371
372         while (1) {
373                 /* XXX use select for timeout */
374                 c = uart_recv(GPS_UART);
375                 ret = recv_cb(c);
376                 if (ret == 0)
377                         return 0;
378         }
379 }
380
381 int wait_ack(int msg_type)
382 {
383         int ret;
384
385         while (1) {
386                 ret = recv_msg();
387                 if (ret < 0)
388                         return -1;
389
390                 /* retry if it's not the expected message */
391                 if (rxframe.data[0] != 0x83 && rxframe.data[0] != 0x84)
392                         continue;
393                 if (rxframe.data[1] != msg_type)
394                         continue;
395
396                 if (rxframe.data[0] == 0x83)
397                         printf("ACK\n");
398                 else if (rxframe.data[0] == 0x84)
399                         printf("NACK\n");
400                 else
401                         printf("ZARB\n");
402                 break;
403         }
404
405         return 0;
406 }
407
408 static int decode_gps_pos(uint8_t *buf, uint16_t len)
409 {
410         struct gps_pos *pos = (struct gps_pos *)buf;
411
412         if (len != sizeof(*pos))
413                 return -1;
414
415         gps_pos.gps_week = ntohs(pos->gps_week);
416         gps_pos.tow = ntohl(pos->tow);
417
418         gps_pos.latitude = ntohl(pos->latitude);
419         gps_pos.longitude = ntohl(pos->longitude);
420         gps_pos.altitude = ntohl(pos->altitude);
421
422         gps_pos.sea_altitude = ntohl(pos->sea_altitude);
423
424         gps_pos.gdop = ntohs(pos->gdop);
425         gps_pos.pdop = ntohs(pos->pdop);
426         gps_pos.hdop = ntohs(pos->hdop);
427         gps_pos.vdop = ntohs(pos->vdop);
428         gps_pos.tdop = ntohs(pos->tdop);
429
430         gps_pos.ecef_vx = ntohl(pos->ecef_vx);
431         gps_pos.ecef_vy = ntohl(pos->ecef_vy);
432         gps_pos.ecef_vz = ntohl(pos->ecef_vz);
433
434         return 0;
435 }
436
437 /* display current GPS position stored in the global variable */
438 static void display_gps(void)
439 {
440         printf("id %.2X mode %.2X svnum %.2X gpsw %.4X tow %.10"PRIu32"\t",
441                 gps_pos.msg_id,
442                 gps_pos.mode,
443                 gps_pos.sv_num,
444                 gps_pos.gps_week,
445                 gps_pos.tow);
446
447         printf("lat %.8"PRIx32" long %.8"PRIx32" alt %.8"PRIx32"\n",
448                 gps_pos.latitude,
449                 gps_pos.longitude,
450                 gps_pos.altitude);
451
452         printf("gdop %3.3f pdop %3.3f hdop %3.3f vdop %3.3f tdop %3.3f\n",
453                 (double)gps_pos.gdop/100.,
454                 (double)gps_pos.pdop/100.,
455                 (double)gps_pos.hdop/100.,
456                 (double)gps_pos.vdop/100.,
457                 (double)gps_pos.tdop/100.);
458
459         printf("lat %3.5f long %3.5f alt %3.5f sea_alt %3.5f\n",
460                 (double)gps_pos.latitude/10000000.,
461                 (double)gps_pos.longitude/10000000.,
462                 (double)gps_pos.altitude/100.,
463                 (double)gps_pos.sea_altitude/100.);
464
465         printf("vx %3.3f vy %3.3f vz %3.3f\n",
466                 (double)gps_pos.ecef_vx/100.,
467                 (double)gps_pos.ecef_vy/100.,
468                 (double)gps_pos.ecef_vz/100.);
469 }
470
471 static void gps_venus_cb(struct callout_mgr *cm, struct callout *tim, void *arg)
472 {
473         int16_t c;
474         int ret;
475
476         (void)cm;
477         (void)tim;
478         (void)arg;
479
480         while (1) {
481                 c = uart_recv_nowait(GPS_UART);
482                 if (c < 0) /* no more char */
483                         goto resched;
484
485                 ret = recv_cb(c);
486                 if (ret == 0) {
487                         decode_gps_pos(rxframe.data, rxframe.len);
488                         if (0)
489                                 display_gps();
490                 }
491         }
492
493  resched:
494         callout_schedule(cm, tim, 2);
495 }
496
497 static void venus634_configure(void)
498 {
499         /* ask the GPS to reset */
500         printf("init...");
501         venus634_restart();
502         wait_ack(M_RESTART);
503
504         /* it seems we must wait that the GPS is restarted, else it doesn't work
505          * properly */
506         wait_ms(500);
507
508         printf("binmode...");
509         venus634_msg_type();
510         wait_ack(M_OUTPUT);
511
512         printf("waas...");
513         venus634_waas();
514         wait_ack(M_WAAS);
515
516         printf("rate...");
517         venus634_rate();
518         wait_ack(M_RATE);
519
520         printf("GPS configuration done !\n");
521 }
522
523 /*
524   https://www.sparkfun.com/datasheets/GPS/Modules/AN0003_v1.4.14_FlashOnly.pdf
525 */
526
527 int gps_venus_init(void)
528 {
529         venus634_configure();
530
531         callout_init(&gps_timer, gps_venus_cb, NULL, GPS_PRIO);
532         callout_schedule(&imuboard.intr_cm, &gps_timer, 2); /* every 2ms */
533
534         return 0;
535 }
536
537 void gps_get_pos(struct gps_pos *pos)
538 {
539         memcpy(pos, &gps_pos, sizeof(*pos));
540 }
541
542 int gps_loop(void)
543 {
544         uint32_t ms;
545         uint8_t flags, prio;
546         int16_t len;
547         char buf[128];
548         struct gps_pos pos;
549
550         while (1) {
551
552                 IRQ_LOCK(flags);
553                 ms = global_ms;
554                 IRQ_UNLOCK(flags);
555
556                 /* get position (prevent modification of gps pos during copy) */
557                 prio = callout_mgr_set_prio(&imuboard.intr_cm, GPS_PRIO);
558                 gps_get_pos(&pos);
559                 callout_mgr_restore_prio(&imuboard.intr_cm, prio);
560
561                 /* XXX copy */
562                 len = snprintf(buf, sizeof(buf),
563                         "%"PRIu32" "
564                         "svnum %.2X lat %3.5f long %3.5f "
565                         "alt %3.5f sea_alt %3.5f\n",
566                         ms, gps_pos.sv_num,
567                         (double)gps_pos.latitude/10000000.,
568                         (double)gps_pos.longitude/10000000.,
569                         (double)gps_pos.altitude/100.,
570                         (double)gps_pos.sea_altitude/100.);
571
572
573                 if (sd_log_enabled()) {
574
575                         if (sd_log_write(buf, len) != len) {
576                                 printf_P(PSTR("error writing to file\n"));
577                                 return -1;
578                         }
579                 }
580         }
581
582         return 0;
583 }