Blame view

doc/README.console 3.08 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  SPDX-License-Identifier: GPL-2.0+
cc1c8a136   wdenk   Initial revision
2
3
4
  /*
   * (C) Copyright 2000
   * Paolo Scaffardi, AIRVENT SAM s.p.a - RIMINI(ITALY), arsenio@tin.it
cc1c8a136   wdenk   Initial revision
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
   */
  
  U-Boot console handling
  ========================
  
  HOW THE CONSOLE WORKS?
  ----------------------
  
  At system startup U-Boot initializes a serial console. When U-Boot
  relocates itself to RAM, all console drivers are initialized (they
  will register all detected console devices to the system for further
  use).
  
  If not defined in the environment, the first input device is assigned
  to the 'stdin' file, the first output one to 'stdout' and 'stderr'.
  
  You can use the command "coninfo" to see all registered console
  devices and their flags. You can assign a standard file (stdin,
  stdout or stderr) to any device you see in that list simply by
  assigning its name to the corresponding environment variable. For
  example:
dc2164da4   Masahiro Yamada   powerpc: mpc8xx: ...
26
      setenv stdin serial		<- To use the serial input
cc1c8a136   wdenk   Initial revision
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
      setenv stdout video		<- To use the video console
  
  Do a simple "saveenv" to save the console settings in the environment
  and get them working on the next startup, too.
  
  HOW CAN I USE STANDARD FILE INTO THE SOURCES?
  ---------------------------------------------
  
  You can use the following functions to access the console:
  
  * STDOUT:
      putc	(to put a char to stdout)
      puts	(to put a string to stdout)
      printf	(to format and put a string to stdout)
  
  * STDIN:
      tstc	(to test for the presence of a char in stdin)
      getc	(to get a char from stdin)
  
  * STDERR:
      eputc	(to put a char to stderr)
      eputs	(to put a string to stderr)
      eprintf	(to format and put a string to stderr)
  
  * FILE (can be 'stdin', 'stdout', 'stderr'):
      fputc	(like putc but redirected to a file)
      fputs	(like puts but redirected to a file)
      fprintf	(like printf but redirected to a file)
      ftstc	(like tstc but redirected to a file)
      fgetc	(like getc but redirected to a file)
  
  Remember that all FILE-related functions CANNOT be used before
7de17781a   Vladimir Zapolskiy   doc: provide a co...
59
  U-Boot relocation (done in 'board_init_r' in arch/*/lib/board.c).
cc1c8a136   wdenk   Initial revision
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  
  HOW CAN I USE STANDARD FILE INTO APPLICATIONS?
  ----------------------------------------------
  
  Use the 'bd_mon_fnc' field of the bd_t structure passed to the
  application to do everything you want with the console.
  
  But REMEMBER that that will work only if you have not overwritten any
  U-Boot code while loading (or uncompressing) the image of your
  application.
  
  For example, you won't get the console stuff running in the Linux
  kernel because the kernel overwrites U-Boot before running. Only
  some parameters like the framebuffer descriptors are passed to the
  kernel in the high memory area to let the applications (the kernel)
  use the framebuffers initialized by U-Boot.
  
  SUPPORTED DRIVERS
  -----------------
  
  Working drivers:
53677ef18   Wolfgang Denk   Big white-space c...
81
82
      serial	(architecture dependent serial stuff)
      video	(mpc8xx video controller)
cc1c8a136   wdenk   Initial revision
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  
  Work in progress:
  
      wl_kbd	(Wireless 4PPM keyboard)
  
  Waiting for volounteers:
  
      lcd	(mpc8xx lcd controller; to )
  
  TESTED CONFIGURATIONS
  ---------------------
  
  The driver has been tested with the following configurations (see
  CREDITS for other contact informations):
53677ef18   Wolfgang Denk   Big white-space c...
97
  - MPC823FADS with AD7176 on a PAL TV (YCbYCr)	- arsenio@tin.it