common/stdio.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2009 Sergey Kubushyn <ksi@koi8.net>
   4  *
   5  * Changes for multibus/multiadapter I2C support.
   6  *
   7  * (C) Copyright 2000
   8  * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
   9  */
  10
  11 #include <config.h>
  12 #include <common.h>
  13 #include <dm.h>
  14 #include <errno.h>
  15 #include <log.h>
  16 #include <stdarg.h>
  17 #include <malloc.h>
  18 #include <stdio_dev.h>
  19 #include <serial.h>
  20 #include <splash.h>
  21
  22 #if defined(CONFIG_SYS_I2C)
  23 #include <i2c.h>
  24 #endif
  25
  26 #include <dm/device-internal.h>
  27
  28 DECLARE_GLOBAL_DATA_PTR;
  29
  30 static struct stdio_dev devs;
  31 struct stdio_dev *stdio_devices[] = { NULL, NULL, NULL };
  32 char *stdio_names[MAX_FILES] = { "stdin", "stdout", "stderr" };
  33
  34 static void nulldev_putc(struct stdio_dev *dev, const char c)
  35 {
  36         /* nulldev is empty! */
  37 }
  38
  39 static void nulldev_puts(struct stdio_dev *dev, const char *s)
  40 {
  41         /* nulldev is empty! */
  42 }
  43
  44 static int nulldev_input(struct stdio_dev *dev)
  45 {
  46         /* nulldev is empty! */
  47         return 0;
  48 }
  49
  50 static void stdio_serial_putc(struct stdio_dev *dev, const char c)
  51 {
  52         serial_putc(c);
  53 }
  54
  55 static void stdio_serial_puts(struct stdio_dev *dev, const char *s)
  56 {
  57         serial_puts(s);
  58 }
  59
  60 static int stdio_serial_getc(struct stdio_dev *dev)
  61 {
  62         return serial_getc();
  63 }
  64
  65 static int stdio_serial_tstc(struct stdio_dev *dev)
  66 {
  67         return serial_tstc();
  68 }
  69
  70 /**************************************************************************
  71  * SYSTEM DRIVERS
  72  **************************************************************************
  73  */
  74
  75 static void drv_system_init (void)
  76 {
  77         struct stdio_dev dev;
  78
  79         memset (&dev, 0, sizeof (dev));
  80
  81         strcpy (dev.name, "serial");
  82         dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
  83         dev.putc = stdio_serial_putc;
  84         dev.puts = stdio_serial_puts;
  85         dev.getc = stdio_serial_getc;
  86         dev.tstc = stdio_serial_tstc;
  87         stdio_register (&dev);
  88
  89         if (CONFIG_IS_ENABLED(SYS_DEVICE_NULLDEV)) {
  90                 memset(&dev, '\0', sizeof(dev));
  91
  92                 strcpy(dev.name, "nulldev");
  93                 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
  94                 dev.putc = nulldev_putc;
  95                 dev.puts = nulldev_puts;
  96                 dev.getc = nulldev_input;
  97                 dev.tstc = nulldev_input;
  98
  99                 stdio_register(&dev);
 100         }
 101 }
 102
 103 /**************************************************************************
 104  * DEVICES
 105  **************************************************************************
 106  */
 107 struct list_head* stdio_get_list(void)
 108 {
 109         return &(devs.list);
 110 }
 111
 112 #ifdef CONFIG_DM_VIDEO
 113 /**
 114  * stdio_probe_device() - Find a device which provides the given stdio device
 115  *
 116  * This looks for a device of the given uclass which provides a particular
 117  * stdio device. It is currently really only useful for UCLASS_VIDEO.
 118  *
 119  * Ultimately we want to be able to probe a device by its stdio name. At
 120  * present devices register in their probe function (for video devices this
 121  * is done in vidconsole_post_probe()) and we don't know what name they will
 122  * use until they do so.
 123  * TODO(sjg@chromium.org): We should be able to determine the name before
 124  * probing, and probe the required device.
 125  *
 126  * @name:       stdio device name (e.g. "vidconsole")
 127  * id:          Uclass ID of device to look for (e.g. UCLASS_VIDEO)
 128  * @sdevp:      Returns stdout device, if found, else NULL
 129  * @return 0 if found, -ENOENT if no device found with that name, other -ve
 130  *         on other error
 131  */
 132 static int stdio_probe_device(const char *name, enum uclass_id id,
 133                               struct stdio_dev **sdevp)
 134 {
 135         struct stdio_dev *sdev;
 136         struct udevice *dev;
 137         int seq, ret;
 138
 139         *sdevp = NULL;
 140         seq = trailing_strtoln(name, NULL);
 141         if (seq == -1)
 142                 seq = 0;
 143         ret = uclass_get_device_by_seq(id, seq, &dev);
 144         if (ret == -ENODEV)
 145                 ret = uclass_first_device_err(id, &dev);
 146         if (ret) {
 147                 debug("No %s device for seq %d (%s)\n", uclass_get_name(id),
 148                       seq, name);
 149                 return ret;
 150         }
 151         /* The device should be be the last one registered */
 152         sdev = list_empty(&devs.list) ? NULL :
 153                         list_last_entry(&devs.list, struct stdio_dev, list);
 154         if (!sdev || strcmp(sdev->name, name)) {
 155                 debug("Device '%s' did not register with stdio as '%s'\n",
 156                       dev->name, name);
 157                 return -ENOENT;
 158         }
 159         *sdevp = sdev;
 160
 161         return 0;
 162 }
 163 #endif
 164
 165 struct stdio_dev *stdio_get_by_name(const char *name)
 166 {
 167         struct list_head *pos;
 168         struct stdio_dev *sdev;
 169
 170         if (!name)
 171                 return NULL;
 172
 173         list_for_each(pos, &(devs.list)) {
 174                 sdev = list_entry(pos, struct stdio_dev, list);
 175                 if (strcmp(sdev->name, name) == 0)
 176                         return sdev;
 177         }
 178 #ifdef CONFIG_DM_VIDEO
 179         /*
 180          * We did not find a suitable stdio device. If there is a video
 181          * driver with a name starting with 'vidconsole', we can try probing
 182          * that in the hope that it will produce the required stdio device.
 183          *
 184          * This function is sometimes called with the entire value of
 185          * 'stdout', which may include a list of devices separate by commas.
 186          * Obviously this is not going to work, so we ignore that case. The
 187          * call path in that case is console_init_r() -> search_device() ->
 188          * stdio_get_by_name().
 189          */
 190         if (!strncmp(name, "vidconsole", 10) && !strchr(name, ',') &&
 191             !stdio_probe_device(name, UCLASS_VIDEO, &sdev))
 192                 return sdev;
 193 #endif
 194
 195         return NULL;
 196 }
 197
 198 struct stdio_dev* stdio_clone(struct stdio_dev *dev)
 199 {
 200         struct stdio_dev *_dev;
 201
 202         if(!dev)
 203                 return NULL;
 204
 205         _dev = calloc(1, sizeof(struct stdio_dev));
 206
 207         if(!_dev)
 208                 return NULL;
 209
 210         memcpy(_dev, dev, sizeof(struct stdio_dev));
 211
 212         return _dev;
 213 }
 214
 215 int stdio_register_dev(struct stdio_dev *dev, struct stdio_dev **devp)
 216 {
 217         struct stdio_dev *_dev;
 218
 219         _dev = stdio_clone(dev);
 220         if(!_dev)
 221                 return -ENODEV;
 222         list_add_tail(&(_dev->list), &(devs.list));
 223         if (devp)
 224                 *devp = _dev;
 225
 226         return 0;
 227 }
 228
 229 int stdio_register(struct stdio_dev *dev)
 230 {
 231         return stdio_register_dev(dev, NULL);
 232 }
 233
 234 /* deregister the device "devname".
 235  * returns 0 if success, -1 if device is assigned and 1 if devname not found
 236  */
 237 #if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
 238 int stdio_deregister_dev(struct stdio_dev *dev, int force)
 239 {
 240         int l;
 241         struct list_head *pos;
 242         char temp_names[3][16];
 243
 244         /* get stdio devices (ListRemoveItem changes the dev list) */
 245         for (l=0 ; l< MAX_FILES; l++) {
 246                 if (stdio_devices[l] == dev) {
 247                         if (force) {
 248                                 strcpy(temp_names[l], "nulldev");
 249                                 continue;
 250                         }
 251                         /* Device is assigned -> report error */
 252                         return -1;
 253                 }
 254                 memcpy (&temp_names[l][0],
 255                         stdio_devices[l]->name,
 256                         sizeof(temp_names[l]));
 257         }
 258
 259         list_del(&(dev->list));
 260         free(dev);
 261
 262         /* reassign Device list */
 263         list_for_each(pos, &(devs.list)) {
 264                 dev = list_entry(pos, struct stdio_dev, list);
 265                 for (l=0 ; l< MAX_FILES; l++) {
 266                         if(strcmp(dev->name, temp_names[l]) == 0)
 267                                 stdio_devices[l] = dev;
 268                 }
 269         }
 270         return 0;
 271 }
 272
 273 int stdio_deregister(const char *devname, int force)
 274 {
 275         struct stdio_dev *dev;
 276
 277         dev = stdio_get_by_name(devname);
 278
 279         if (!dev) /* device not found */
 280                 return -ENODEV;
 281
 282         return stdio_deregister_dev(dev, force);
 283 }
 284 #endif /* CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER) */
 285
 286 int stdio_init_tables(void)
 287 {
 288 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 289         /* already relocated for current ARM implementation */
 290         ulong relocation_offset = gd->reloc_off;
 291         int i;
 292
 293         /* relocate device name pointers */
 294         for (i = 0; i < (sizeof (stdio_names) / sizeof (char *)); ++i) {
 295                 stdio_names[i] = (char *) (((ulong) stdio_names[i]) +
 296                                                 relocation_offset);
 297         }
 298 #endif /* CONFIG_NEEDS_MANUAL_RELOC */
 299
 300         /* Initialize the list */
 301         INIT_LIST_HEAD(&(devs.list));
 302
 303         return 0;
 304 }
 305
 306 int stdio_add_devices(void)
 307 {
 308 #ifdef CONFIG_DM_KEYBOARD
 309         struct udevice *dev;
 310         struct uclass *uc;
 311         int ret;
 312
 313         /*
 314          * For now we probe all the devices here. At some point this should be
 315          * done only when the devices are required - e.g. we have a list of
 316          * input devices to start up in the stdin environment variable. That
 317          * work probably makes more sense when stdio itself is converted to
 318          * driver model.
 319          *
 320          * TODO(sjg@chromium.org): Convert changing uclass_first_device() etc.
 321          * to return the device even on error. Then we could use that here.
 322          */
 323         ret = uclass_get(UCLASS_KEYBOARD, &uc);
 324         if (ret)
 325                 return ret;
 326
 327         /* Don't report errors to the caller - assume that they are non-fatal */
 328         uclass_foreach_dev(dev, uc) {
 329                 ret = device_probe(dev);
 330                 if (ret)
 331                         printf("Failed to probe keyboard '%s'\n", dev->name);
 332         }
 333 #endif
 334 #ifdef CONFIG_SYS_I2C
 335         i2c_init_all();
 336 #else
 337 #endif
 338 #ifdef CONFIG_DM_VIDEO
 339         /*
 340          * If the console setting is not in environment variables then
 341          * console_init_r() will not be calling iomux_doenv() (which calls
 342          * search_device()). So we will not dynamically add devices by
 343          * calling stdio_probe_device().
 344          *
 345          * So just probe all video devices now so that whichever one is
 346          * required will be available.
 347          */
 348 #ifndef CONFIG_SYS_CONSOLE_IS_IN_ENV
 349         struct udevice *vdev;
 350 # ifndef CONFIG_DM_KEYBOARD
 351         int ret;
 352 # endif
 353
 354         for (ret = uclass_first_device(UCLASS_VIDEO, &vdev);
 355              vdev;
 356              ret = uclass_next_device(&vdev))
 357                 ;
 358         if (ret)
 359                 printf("%s: Video device failed (ret=%d)\n", __func__, ret);
 360 #endif /* !CONFIG_SYS_CONSOLE_IS_IN_ENV */
 361 #if defined(CONFIG_SPLASH_SCREEN) && defined(CONFIG_CMD_BMP)
 362         splash_display();
 363 #endif /* CONFIG_SPLASH_SCREEN && CONFIG_CMD_BMP */
 364 #else
 365 # if defined(CONFIG_LCD)
 366         drv_lcd_init ();
 367 # endif
 368 # if defined(CONFIG_VIDEO) || defined(CONFIG_CFB_CONSOLE)
 369         drv_video_init ();
 370 # endif
 371 #endif /* CONFIG_DM_VIDEO */
 372 #if defined(CONFIG_KEYBOARD) && !defined(CONFIG_DM_KEYBOARD)
 373         drv_keyboard_init ();
 374 #endif
 375         drv_system_init ();
 376         serial_stdio_init ();
 377 #ifdef CONFIG_USB_TTY
 378         drv_usbtty_init ();
 379 #endif
 380 #ifdef CONFIG_NETCONSOLE
 381         drv_nc_init ();
 382 #endif
 383 #ifdef CONFIG_JTAG_CONSOLE
 384         drv_jtag_console_init ();
 385 #endif
 386 #ifdef CONFIG_CBMEM_CONSOLE
 387         cbmemc_init();
 388 #endif
 389
 390         return 0;
 391 }
 392
 393 int stdio_init(void)
 394 {
 395         stdio_init_tables();
 396         stdio_add_devices();
 397
 398         return 0;
 399 }