can-utils/lib.c

   1 /*
   2  *  $Id$
   3  */
   4
   5 /*
   6  * lib.c - library for command line tools
   7  *
   8  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. Neither the name of Volkswagen nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * Alternatively, provided that this notice is retained in full, this
  24  * software may be distributed under the terms of the GNU General
  25  * Public License ("GPL") version 2, in which case the provisions of the
  26  * GPL apply INSTEAD OF those given above.
  27  *
  28  * The provided data structures and external interfaces from this code
  29  * are not restricted to be used by modules with a GPL compatible license.
  30  *
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  36  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  37  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  38  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  39  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  41  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  42  * DAMAGE.
  43  *
  44  * Send feedback to <socketcan-users@lists.berlios.de>
  45  *
  46  */
  47
  48 #include <stdio.h>
  49 #include <string.h>
  50
  51 #include <sys/socket.h> /* for sa_family_t */
  52 #include <linux/can.h>
  53
  54 #include "lib.h"
  55
  56 #define CANID_DELIM '#'
  57 #define DATA_SEPERATOR '.'
  58
  59 #define MAX_CANFRAME      "12345678#01.23.45.67.89.AB.CD.EF"
  60 #define MAX_LONG_CANFRAME "12345678  [8] 10101010 10101010 10101010 10101010 10101010 10101010 10101010 10101010   '........'"
  61
  62 unsigned char asc2nibble(char c) {
  63
  64         if ((c >= '0') && (c <= '9'))
  65                 return c - '0';
  66
  67         if ((c >= 'A') && (c <= 'F'))
  68                 return c - 'A' + 10;
  69
  70         if ((c >= 'a') && (c <= 'f'))
  71                 return c - 'a' + 10;
  72
  73         return 16; /* error */
  74 }
  75
  76 int hexstring2candata(char *arg, struct can_frame *cf) {
  77
  78         int len = strlen(arg);
  79         int i;
  80         unsigned char tmp;
  81
  82         if (!len || len%2 || len > 16)
  83                 return 1;
  84
  85         for (i=0; i < len/2; i++) {
  86
  87                 tmp = asc2nibble(*(arg+(2*i)));
  88                 if (tmp > 0x0F)
  89                         return 1;
  90
  91                 cf->data[i] = (tmp << 4);
  92
  93                 tmp = asc2nibble(*(arg+(2*i)+1));
  94                 if (tmp > 0x0F)
  95                         return 1;
  96
  97                 cf->data[i] |= tmp;
  98         }
  99
 100         return 0;
 101 }
 102
 103 int parse_canframe(char *cs, struct can_frame *cf) {
 104         /* documentation see lib.h */
 105
 106         int i, idx, dlc, len;
 107         unsigned char tmp;
 108
 109         len = strlen(cs);
 110         //printf("'%s' len %d\n", cs, len);
 111
 112         memset(cf, 0, sizeof(*cf)); /* init CAN frame, e.g. DLC = 0 */
 113
 114         if (len < 4)
 115                 return 1;
 116
 117         if (!((cs[3] == CANID_DELIM) || (cs[8] == CANID_DELIM)))
 118                 return 1;
 119
 120         if (cs[8] == CANID_DELIM) { /* 8 digits */
 121
 122                 idx = 9;
 123                 for (i=0; i<8; i++){
 124                         if ((tmp = asc2nibble(cs[i])) > 0x0F)
 125                                 return 1;
 126                         cf->can_id |= (tmp << (7-i)*4);
 127                 }
 128                 if (!(cf->can_id & CAN_ERR_FLAG)) /* 8 digits but no errorframe?  */
 129                         cf->can_id |= CAN_EFF_FLAG;   /* then it is an extended frame */
 130
 131         } else { /* 3 digits */
 132
 133                 idx = 4;
 134                 for (i=0; i<3; i++){
 135                         if ((tmp = asc2nibble(cs[i])) > 0x0F)
 136                                 return 1;
 137                         cf->can_id |= (tmp << (2-i)*4);
 138                 }
 139         }
 140
 141         if((cs[idx] == 'R') || (cs[idx] == 'r')){ /* RTR frame */
 142                 cf->can_id |= CAN_RTR_FLAG;
 143                 return 0;
 144         }
 145
 146         for (i=0, dlc=0; i<8; i++){
 147
 148                 if(cs[idx] == DATA_SEPERATOR) /* skip (optional) seperator */
 149                         idx++;
 150
 151                 if(idx >= len) /* end of string => end of data */
 152                         break;
 153
 154                 if ((tmp = asc2nibble(cs[idx++])) > 0x0F)
 155                         return 1;
 156                 cf->data[i] = (tmp << 4);
 157                 if ((tmp = asc2nibble(cs[idx++])) > 0x0F)
 158                         return 1;
 159                 cf->data[i] |= tmp;
 160                 dlc++;
 161         }
 162
 163         cf->can_dlc = dlc;
 164
 165         return 0;
 166 }
 167
 168 void fprint_canframe(FILE *stream , struct can_frame *cf, char *eol, int sep) {
 169         /* documentation see lib.h */
 170
 171         char buf[sizeof(MAX_CANFRAME)+1]; /* max length */
 172
 173         sprint_canframe(buf, cf, sep);
 174         fprintf(stream, "%s", buf);
 175         if (eol)
 176                 fprintf(stream, "%s", eol);
 177 }
 178
 179 void sprint_canframe(char *buf , struct can_frame *cf, int sep) {
 180         /* documentation see lib.h */
 181
 182         int i,offset;
 183         int dlc = (cf->can_dlc > 8)? 8 : cf->can_dlc;
 184
 185         if (cf->can_id & CAN_ERR_FLAG) {
 186                 sprintf(buf, "%08X#", cf->can_id & (CAN_ERR_MASK|CAN_ERR_FLAG));
 187                 offset = 9;
 188         } else if (cf->can_id & CAN_EFF_FLAG) {
 189                 sprintf(buf, "%08X#", cf->can_id & CAN_EFF_MASK);
 190                 offset = 9;
 191         } else {
 192                 sprintf(buf, "%03X#", cf->can_id & CAN_SFF_MASK);
 193                 offset = 4;
 194         }
 195
 196         if (cf->can_id & CAN_RTR_FLAG) /* there are no ERR frames with RTR */
 197                 sprintf(buf+offset, "R");
 198         else
 199                 for (i = 0; i < dlc; i++) {
 200                         sprintf(buf+offset, "%02X", cf->data[i]);
 201                         offset += 2;
 202                         if (sep && (i+1 < dlc))
 203                                 sprintf(buf+offset++, ".");
 204                 }
 205
 206
 207 }
 208
 209 void fprint_long_canframe(FILE *stream , struct can_frame *cf, char *eol, int view) {
 210         /* documentation see lib.h */
 211
 212         char buf[sizeof(MAX_LONG_CANFRAME)+1]; /* max length */
 213
 214         sprint_long_canframe(buf, cf, view);
 215         fprintf(stream, "%s", buf);
 216         if (eol)
 217                 fprintf(stream, "%s", eol);
 218 }
 219
 220 void sprint_long_canframe(char *buf , struct can_frame *cf, int view) {
 221         /* documentation see lib.h */
 222
 223         int i, j, dlen, offset;
 224         int dlc = (cf->can_dlc > 8)? 8 : cf->can_dlc;
 225
 226         if (cf->can_id & CAN_ERR_FLAG) {
 227                 sprintf(buf, "%8X  ", cf->can_id & (CAN_ERR_MASK|CAN_ERR_FLAG));
 228                 offset = 10;
 229         } else if (cf->can_id & CAN_EFF_FLAG) {
 230                 sprintf(buf, "%8X  ", cf->can_id & CAN_EFF_MASK);
 231                 offset = 10;
 232         } else {
 233                 sprintf(buf, "%3X  ", cf->can_id & CAN_SFF_MASK);
 234                 offset = 5;
 235         }
 236
 237         sprintf(buf+offset, "[%d]", dlc);
 238         offset += 3;
 239
 240         if (cf->can_id & CAN_RTR_FLAG) { /* there are no ERR frames with RTR */
 241                 sprintf(buf+offset, " remote request");
 242                 return;
 243         }
 244
 245         if (view & CANLIB_VIEW_BINARY) {
 246                 dlen = 9; /* _10101010 */
 247                 if (view & CANLIB_VIEW_SWAP) {
 248                         for (i = dlc - 1; i >= 0; i--) {
 249                                 buf[offset++] = (i == dlc-1)?' ':SWAP_DELIMITER;
 250                                 for (j = 7; j >= 0; j--)
 251                                         buf[offset++] = (1<<j & cf->data[i])?'1':'0';
 252                         }
 253                 } else {
 254                         for (i = 0; i < dlc; i++) {
 255                                 buf[offset++] = ' ';
 256                                 for (j = 7; j >= 0; j--)
 257                                         buf[offset++] = (1<<j & cf->data[i])?'1':'0';
 258                         }
 259                 }
 260                 buf[offset] = 0; /* terminate string */
 261         } else {
 262                 dlen = 3; /* _AA */
 263                 if (view & CANLIB_VIEW_SWAP) {
 264                         for (i = dlc - 1; i >= 0; i--) {
 265                                 sprintf(buf+offset, "%c%02X",
 266                                         (i == dlc-1)?' ':SWAP_DELIMITER,
 267                                         cf->data[i]);
 268                                 offset += dlen;
 269                         }
 270                 } else {
 271                         for (i = 0; i < dlc; i++) {
 272                                 sprintf(buf+offset, " %02X", cf->data[i]);
 273                                 offset += dlen;
 274                         }
 275                 }
 276         }
 277
 278         if (cf->can_id & CAN_ERR_FLAG)
 279                 sprintf(buf+offset, "%*s", dlen*(8-dlc)+13, "ERRORFRAME");
 280         else if (view & CANLIB_VIEW_ASCII) {
 281                 j = dlen*(8-dlc)+4;
 282                 if (view & CANLIB_VIEW_SWAP) {
 283                         sprintf(buf+offset, "%*s", j, "`");
 284                         offset += j;
 285                         for (i = dlc - 1; i >= 0; i--)
 286                                 if ((cf->data[i] > 0x1F) && (cf->data[i] < 0x7F))
 287                                         buf[offset++] = cf->data[i];
 288                                 else
 289                                         buf[offset++] = '.';
 290
 291                         sprintf(buf+offset, "`");
 292                 } else {
 293                         sprintf(buf+offset, "%*s", j, "'");
 294                         offset += j;
 295                         for (i = 0; i < dlc; i++)
 296                                 if ((cf->data[i] > 0x1F) && (cf->data[i] < 0x7F))
 297                                         buf[offset++] = cf->data[i];
 298                                 else
 299                                         buf[offset++] = '.';
 300
 301                         sprintf(buf+offset, "'");
 302                 }
 303         }
 304 }
 305