common/cmd_led.c

   1 /*
   2  * (C) Copyright 2010
   3  * Jason Kridner <jkridner@beagleboard.org>
   4  *
   5  * Based on cmd_led.c patch from:
   6  * http://www.mail-archive.com/u-boot@lists.denx.de/msg06873.html
   7  * (C) Copyright 2008
   8  * Ulf Samuelsson <ulf.samuelsson@atmel.com>
   9  *
  10  * SPDX-License-Identifier:     GPL-2.0+
  11  */
  12
  13 #include <common.h>
  14 #include <config.h>
  15 #include <command.h>
  16 #include <status_led.h>
  17
  18 struct led_tbl_s {
  19         char            *string;        /* String for use in the command */
  20         led_id_t        mask;           /* Mask used for calling __led_set() */
  21         void            (*off)(void);   /* Optional function for turning LED off */
  22         void            (*on)(void);    /* Optional function for turning LED on */
  23         void            (*toggle)(void);/* Optional function for toggling LED */
  24 };
  25
  26 typedef struct led_tbl_s led_tbl_t;
  27
  28 static const led_tbl_t led_commands[] = {
  29 #ifdef CONFIG_BOARD_SPECIFIC_LED
  30 #ifdef STATUS_LED_BIT
  31         { "0", STATUS_LED_BIT, NULL, NULL, NULL },
  32 #endif
  33 #ifdef STATUS_LED_BIT1
  34         { "1", STATUS_LED_BIT1, NULL, NULL, NULL },
  35 #endif
  36 #ifdef STATUS_LED_BIT2
  37         { "2", STATUS_LED_BIT2, NULL, NULL, NULL },
  38 #endif
  39 #ifdef STATUS_LED_BIT3
  40         { "3", STATUS_LED_BIT3, NULL, NULL, NULL },
  41 #endif
  42 #ifdef STATUS_LED_BIT4
  43         { "4", STATUS_LED_BIT4, NULL, NULL, NULL },
  44 #endif
  45 #ifdef STATUS_LED_BIT5
  46         { "5", STATUS_LED_BIT5, NULL, NULL, NULL },
  47 #endif
  48 #endif
  49 #ifdef STATUS_LED_GREEN
  50         { "green", STATUS_LED_GREEN, green_led_off, green_led_on, NULL },
  51 #endif
  52 #ifdef STATUS_LED_YELLOW
  53         { "yellow", STATUS_LED_YELLOW, yellow_led_off, yellow_led_on, NULL },
  54 #endif
  55 #ifdef STATUS_LED_RED
  56         { "red", STATUS_LED_RED, red_led_off, red_led_on, NULL },
  57 #endif
  58 #ifdef STATUS_LED_BLUE
  59         { "blue", STATUS_LED_BLUE, blue_led_off, blue_led_on, NULL },
  60 #endif
  61         { NULL, 0, NULL, NULL, NULL }
  62 };
  63
  64 enum led_cmd { LED_ON, LED_OFF, LED_TOGGLE, LED_BLINK };
  65
  66 enum led_cmd get_led_cmd(char *var)
  67 {
  68         if (strcmp(var, "off") == 0)
  69                 return LED_OFF;
  70         if (strcmp(var, "on") == 0)
  71                 return LED_ON;
  72         if (strcmp(var, "toggle") == 0)
  73                 return LED_TOGGLE;
  74         if (strcmp(var, "blink") == 0)
  75                 return LED_BLINK;
  76
  77         return -1;
  78 }
  79
  80 /*
  81  * LED drivers providing a blinking LED functionality, like the
  82  * PCA9551, can override this empty weak function
  83  */
  84 void __weak __led_blink(led_id_t mask, int freq)
  85 {
  86 }
  87
  88 int do_led (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  89 {
  90         int i, match = 0;
  91         enum led_cmd cmd;
  92         int freq;
  93
  94         /* Validate arguments */
  95         if ((argc < 3) || (argc > 4))
  96                 return CMD_RET_USAGE;
  97
  98         cmd = get_led_cmd(argv[2]);
  99         if (cmd < 0) {
 100                 return CMD_RET_USAGE;
 101         }
 102
 103         for (i = 0; led_commands[i].string; i++) {
 104                 if ((strcmp("all", argv[1]) == 0) ||
 105                     (strcmp(led_commands[i].string, argv[1]) == 0)) {
 106                         match = 1;
 107                         switch (cmd) {
 108                         case LED_ON:
 109                                 if (led_commands[i].on)
 110                                         led_commands[i].on();
 111                                 else
 112                                         __led_set(led_commands[i].mask,
 113                                                           STATUS_LED_ON);
 114                                 break;
 115                         case LED_OFF:
 116                                 if (led_commands[i].off)
 117                                         led_commands[i].off();
 118                                 else
 119                                         __led_set(led_commands[i].mask,
 120                                                           STATUS_LED_OFF);
 121                                 break;
 122                         case LED_TOGGLE:
 123                                 if (led_commands[i].toggle)
 124                                         led_commands[i].toggle();
 125                                 else
 126                                         __led_toggle(led_commands[i].mask);
 127                                 break;
 128                         case LED_BLINK:
 129                                 if (argc != 4)
 130                                         return CMD_RET_USAGE;
 131
 132                                 freq = simple_strtoul(argv[3], NULL, 10);
 133                                 __led_blink(led_commands[i].mask, freq);
 134                         }
 135                         /* Need to set only 1 led if led_name wasn't 'all' */
 136                         if (strcmp("all", argv[1]) != 0)
 137                                 break;
 138                 }
 139         }
 140
 141         /* If we ran out of matches, print Usage */
 142         if (!match) {
 143                 return CMD_RET_USAGE;
 144         }
 145
 146         return 0;
 147 }
 148
 149 U_BOOT_CMD(
 150         led, 4, 1, do_led,
 151         "["
 152 #ifdef CONFIG_BOARD_SPECIFIC_LED
 153 #ifdef STATUS_LED_BIT
 154         "0|"
 155 #endif
 156 #ifdef STATUS_LED_BIT1
 157         "1|"
 158 #endif
 159 #ifdef STATUS_LED_BIT2
 160         "2|"
 161 #endif
 162 #ifdef STATUS_LED_BIT3
 163         "3|"
 164 #endif
 165 #ifdef STATUS_LED_BIT4
 166         "4|"
 167 #endif
 168 #ifdef STATUS_LED_BIT5
 169         "5|"
 170 #endif
 171 #endif
 172 #ifdef STATUS_LED_GREEN
 173         "green|"
 174 #endif
 175 #ifdef STATUS_LED_YELLOW
 176         "yellow|"
 177 #endif
 178 #ifdef STATUS_LED_RED
 179         "red|"
 180 #endif
 181 #ifdef STATUS_LED_BLUE
 182         "blue|"
 183 #endif
 184         "all] [on|off|toggle|blink] [blink-freq in ms]",
 185         "[led_name] [on|off|toggle|blink] sets or clears led(s)"
 186 );