slcan_attach.c

   1 /*
   2  *  $Id$
   3  */
   4
   5 /*
   6  * slcan_attach.c - userspace tool for serial line CAN interface driver SLCAN
   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 <linux-can@vger.kernel.org>
  45  *
  46  */
  47
  48 #include <stdio.h>
  49 #include <stdlib.h>
  50 #include <string.h>
  51 #include <fcntl.h>
  52 #include <unistd.h>
  53 #include <getopt.h>
  54 #include <sys/socket.h>
  55 #include <sys/ioctl.h>
  56 #include <net/if.h>
  57 #include <termios.h>
  58
  59 #define LDISC_N_SLCAN 17 /* default slcan line discipline since Kernel 2.6.25 */
  60
  61 void print_usage(char *prg)
  62 {
  63         fprintf(stderr, "\nUsage: %s [options] tty\n\n", prg);
  64         fprintf(stderr, "Options: -o         (send open command 'O\\r')\n");
  65         fprintf(stderr, "         -c         (send close command 'C\\r')\n");
  66         fprintf(stderr, "         -f         (read status flags with 'F\\r' to reset error states)\n");
  67         fprintf(stderr, "         -s <speed> (set CAN speed 0..8)\n");
  68         fprintf(stderr, "         -b <btr>   (set bit time register value)\n");
  69         fprintf(stderr, "         -d         (only detach line discipline)\n");
  70         fprintf(stderr, "         -w         (attach - wait for keypess - detach)\n");
  71         fprintf(stderr, "         -n <name>  (assign created netdevice name)\n");
  72         fprintf(stderr, "\nExamples:\n");
  73         fprintf(stderr, "slcan_attach -w -o -f -s6 -c /dev/ttyS1\n");
  74         fprintf(stderr, "slcan_attach /dev/ttyS1\n");
  75         fprintf(stderr, "slcan_attach -d /dev/ttyS1\n");
  76         fprintf(stderr, "slcan_attach -w -n can15 /dev/ttyS1\n");
  77         fprintf(stderr, "\n");
  78         exit(1);
  79 }
  80
  81 int main(int argc, char **argv)
  82 {
  83         int fd;
  84         int ldisc = LDISC_N_SLCAN;
  85         int detach = 0;
  86         int waitkey = 0;
  87         int send_open = 0;
  88         int send_close = 0;
  89         int send_read_status_flags = 0;
  90         char *speed = NULL;
  91         char *btr = NULL;
  92         char buf[IFNAMSIZ+1];
  93         char *tty;
  94         char *name = NULL;
  95         int opt;
  96
  97         while ((opt = getopt(argc, argv, "l:dwocfs:b:n:?")) != -1) {
  98                 switch (opt) {
  99                 case 'l':
 100                         fprintf(stderr, "Ignored option '-l'\n");
 101                         break;
 102
 103                 case 'd':
 104                         detach = 1;
 105                         break;
 106
 107                 case 'w':
 108                         waitkey = 1;
 109                         break;
 110
 111                 case 'o':
 112                         send_open = 1;
 113                         break;
 114
 115                 case 'c':
 116                         send_close = 1;
 117                         break;
 118
 119                 case 'f':
 120                         send_read_status_flags = 1;
 121                         break;
 122
 123                 case 's':
 124                         speed = optarg;
 125                         if (strlen(speed) > 1)
 126                                 print_usage(argv[0]);
 127                         break;
 128
 129                 case 'b':
 130                         btr = optarg;
 131                         if (strlen(btr) > 6)
 132                                 print_usage(argv[0]);
 133                         break;
 134
 135                 case 'n':
 136                         name = optarg;
 137                         if (strlen(name) > IFNAMSIZ-1)
 138                                 print_usage(argv[0]);
 139                         break;
 140
 141                 case '?':
 142                 default:
 143                         print_usage(argv[0]);
 144                         break;
 145                 }
 146         }
 147
 148         if (argc - optind != 1)
 149                 print_usage(argv[0]);
 150
 151         tty = argv[optind];
 152
 153         if ((fd = open (tty, O_WRONLY | O_NOCTTY)) < 0) {
 154                 perror(tty);
 155                 exit(1);
 156         }
 157
 158         if (waitkey || !detach) {
 159
 160                 if (speed) {
 161                         sprintf(buf, "C\rS%s\r", speed);
 162                         write(fd, buf, strlen(buf));
 163                 }
 164
 165                 if (btr) {
 166                         sprintf(buf, "C\rs%s\r", btr);
 167                         write(fd, buf, strlen(buf));
 168                 }
 169
 170                 if (send_read_status_flags) {
 171                         sprintf(buf, "F\r");
 172                         write(fd, buf, strlen(buf));
 173                 }
 174
 175                 if (send_open) {
 176                         sprintf(buf, "O\r");
 177                         write(fd, buf, strlen(buf));
 178                 }
 179
 180                 /* set slcan line discipline on given tty */
 181                 if (ioctl (fd, TIOCSETD, &ldisc) < 0) {
 182                         perror("ioctl TIOCSETD");
 183                         exit(1);
 184                 }
 185
 186                 /* retrieve the name of the created CAN netdevice */
 187                 if (ioctl (fd, SIOCGIFNAME, buf) < 0) {
 188                         perror("ioctl SIOCGIFNAME");
 189                         exit(1);
 190                 }
 191
 192                 printf("attached tty %s to netdevice %s\n", tty, buf);
 193
 194                 /* try to rename the created device if requested */
 195                 if (name) {
 196                         struct ifreq ifr;
 197                         int s = socket(PF_INET, SOCK_DGRAM, 0);
 198
 199                         printf("rename netdevice %s to %s ... ", buf, name);
 200
 201                         if (s < 0)
 202                                 perror("socket for interface rename");
 203                         else {
 204                                 strncpy (ifr.ifr_name, buf, IFNAMSIZ);
 205                                 strncpy (ifr.ifr_newname, name, IFNAMSIZ);
 206
 207                                 if (ioctl(s, SIOCSIFNAME, &ifr) < 0)
 208                                         printf("failed!\n");
 209                                 else
 210                                         printf("ok.\n");
 211
 212                                 close(s);
 213                         }
 214                 }
 215         }
 216
 217         if (waitkey) {
 218                 printf("Press any key to detach %s ...\n", tty);
 219                 getchar();
 220         }
 221
 222         if (waitkey || detach) {
 223                 ldisc = N_TTY;
 224                 if (ioctl (fd, TIOCSETD, &ldisc) < 0) {
 225                         perror("ioctl");
 226                         exit(1);
 227                 }
 228
 229                 if (send_close) {
 230                         sprintf(buf, "C\r");
 231                         write(fd, buf, strlen(buf));
 232                 }
 233         }
 234
 235         close(fd);
 236
 237         return 0;
 238 }