Adding upstream version 4.00~pre55+dfsg.
[syslinux-debian/hramrach.git] / com32 / hdt / hdt-cli.h
blobd9632b2d67888ef237a0b29b28fa25d78e754925
1 /* ----------------------------------------------------------------------- *
3 * Copyright 2009 Erwan Velu - All Rights Reserved
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without
8 * restriction, including without limitation the rights to use,
9 * copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom
11 * the Software is furnished to do so, subject to the following
12 * conditions:
14 * The above copyright notice and this permission notice shall
15 * be included in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
19 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
21 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
22 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
26 * -----------------------------------------------------------------------
29 #ifndef DEFINE_HDT_CLI_H
30 #define DEFINE_HDT_CLI_H
31 #include <stdio.h>
32 #include <getkey.h>
34 #include "hdt-common.h"
36 #define DEBUG 0
37 #if DEBUG
38 # define dprintf printf
39 #else
40 # define dprintf(f, ...) ((void)0)
41 #endif
43 #define MAX_LINE_SIZE 256
45 #define CLI_SPACE " "
46 #define CLI_LF "\n"
47 #define CLI_MENU "menu"
48 #define CLI_CLEAR "clear"
49 #define CLI_EXIT "exit"
50 #define CLI_HELP "help"
51 #define CLI_REBOOT "reboot"
52 #define CLI_SHOW "show"
53 #define CLI_SET "set"
54 #define CLI_MODE "mode"
55 #define CLI_HDT "hdt"
56 #define CLI_PCI "pci"
57 #define CLI_PXE "pxe"
58 #define CLI_KERNEL "kernel"
59 #define CLI_SYSLINUX "syslinux"
60 #define CLI_VESA "vesa"
61 #define CLI_SUMMARY "summary"
62 #define CLI_COMMANDS "commands"
63 #define CLI_DMI "dmi"
64 #define CLI_CPU "cpu"
65 #define CLI_DISK "disk"
66 #define CLI_SHOW_LIST "list"
67 #define CLI_IRQ "irq"
68 #define CLI_MODES "modes"
69 #define CLI_VPD "vpd"
70 #define CLI_MEMORY "memory"
71 #define CLI_ENABLE "enable"
72 #define CLI_DISABLE "disable"
74 typedef enum {
75 INVALID_MODE,
76 EXIT_MODE,
77 HDT_MODE,
78 PCI_MODE,
79 DMI_MODE,
80 CPU_MODE,
81 PXE_MODE,
82 KERNEL_MODE,
83 SYSLINUX_MODE,
84 VESA_MODE,
85 DISK_MODE,
86 VPD_MODE,
87 MEMORY_MODE,
88 } cli_mode_t;
90 #define PROMPT_SIZE 32
91 #define MAX_HISTORY_SIZE 32
92 #define INPUT hdt_cli.history[hdt_cli.history_pos]
93 struct s_cli {
94 cli_mode_t mode;
95 char prompt[PROMPT_SIZE];
96 uint8_t cursor_pos;
97 char history[MAX_HISTORY_SIZE+1][MAX_LINE_SIZE];
98 int history_pos;
99 int max_history_pos;
101 struct s_cli hdt_cli;
103 /* Describe a cli mode */
104 struct cli_mode_descr {
105 const unsigned int mode;
106 const char *name;
107 /* Handle 1-token commands */
108 struct cli_module_descr *default_modules;
109 /* Handle show <module> <args> */
110 struct cli_module_descr *show_modules;
111 /* Handle set <module> <args> */
112 struct cli_module_descr *set_modules;
115 /* Describe a subset of commands in a module (default, show, set, ...) */
116 struct cli_module_descr {
117 struct cli_callback_descr *modules;
118 void (*default_callback) (int argc, char **argv,
119 struct s_hardware * hardware);
122 /* Describe a callback (belongs to a mode and a module) */
123 struct cli_callback_descr {
124 const char *name;
125 void (*exec) (int argc, char **argv, struct s_hardware * hardware);
128 /* Manage aliases */
129 #define MAX_ALIASES 2
130 struct cli_alias {
131 const char *command; /* Original command */
132 const int nb_aliases; /* Size of aliases array */
133 const char **aliases; /* List of aliases */
136 /* List of implemented modes */
137 extern struct cli_mode_descr *list_modes[];
138 struct cli_mode_descr hdt_mode;
139 struct cli_mode_descr dmi_mode;
140 struct cli_mode_descr syslinux_mode;
141 struct cli_mode_descr pxe_mode;
142 struct cli_mode_descr kernel_mode;
143 struct cli_mode_descr cpu_mode;
144 struct cli_mode_descr pci_mode;
145 struct cli_mode_descr vesa_mode;
146 struct cli_mode_descr disk_mode;
147 struct cli_mode_descr vpd_mode;
148 struct cli_mode_descr memory_mode;
150 /* cli helpers */
151 void find_cli_mode_descr(cli_mode_t mode, struct cli_mode_descr **mode_found);
152 void find_cli_callback_descr(const char *module_name,
153 struct cli_module_descr *modules_list,
154 struct cli_callback_descr **module_found);
155 cli_mode_t mode_s_to_mode_t(char *name);
157 void set_mode(cli_mode_t mode, struct s_hardware *hardware);
158 void start_cli_mode(struct s_hardware *hardware);
159 void start_auto_mode(struct s_hardware *hardware);
160 void main_show(char *item, struct s_hardware *hardware);
162 #define CLI_HISTORY "history"
163 void print_history(int argc, char **argv, struct s_hardware * hardware);
165 // DMI STUFF
166 #define CLI_DMI_BASE_BOARD "base_board"
167 #define CLI_DMI_BATTERY "battery"
168 #define CLI_DMI_BIOS "bios"
169 #define CLI_DMI_CHASSIS "chassis"
170 #define CLI_DMI_MEMORY "memory"
171 #define CLI_DMI_MEMORY_BANK "bank"
172 #define CLI_DMI_PROCESSOR "cpu"
173 #define CLI_DMI_SYSTEM "system"
174 #define CLI_DMI_IPMI "ipmi"
175 #define CLI_DMI_CACHE "cache"
176 #define CLI_DMI_OEM "oem"
177 #define CLI_DMI_SECURITY "security"
178 #define CLI_DMI_LIST CLI_SHOW_LIST
179 void main_show_dmi(int argc, char **argv, struct s_hardware *hardware);
180 void show_dmi_memory_modules(int argc, char **argv,
181 struct s_hardware *hardware);
182 void show_dmi_memory_bank(int argc, char **argv, struct s_hardware *hardware);
184 // PCI STUFF
185 #define CLI_PCI_DEVICE "device"
186 void main_show_pci(int argc, char **argv, struct s_hardware *hardware);
187 void cli_detect_pci(struct s_hardware *hardware);
189 // CPU STUFF
190 void main_show_cpu(int argc, char **argv, struct s_hardware *hardware);
192 // DISK STUFF
193 void disks_summary(int argc, char **argv, struct s_hardware *hardware);
195 // PXE STUFF
196 void main_show_pxe(int argc, char **argv, struct s_hardware *hardware);
198 // KERNEL STUFF
199 void main_show_kernel(int argc, char **argv, struct s_hardware *hardware);
201 // SYSLINUX STUFF
202 void main_show_syslinux(int argc, char **argv, struct s_hardware *hardware);
204 // VESA STUFF
205 void main_show_vesa(int argc, char **argv, struct s_hardware *hardware);
207 // VPD STUFF
208 void main_show_vpd(int argc __unused, char **argv __unused,
209 struct s_hardware *hardware);
210 #endif