2 * Copyright (C) 2009 Sony Computer Entertainment Inc.
3 * Copyright 2009 Sony Corp.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #if defined(HAVE_CONFIG_H)
28 #include <sys/ioctl.h>
31 #include "pb-protocol/pb-protocol.h"
32 #include "talloc/talloc.h"
33 #include "waiter/waiter.h"
34 #include "process/process.h"
35 #include "ui/common/discover-client.h"
36 #include "ui/common/ui-system.h"
38 #include "nc-boot-editor.h"
39 #include "nc-config.h"
40 #include "nc-sysinfo.h"
41 #include "nc-helpscreen.h"
43 static void cui_start(void)
45 initscr(); /* Initialize ncurses. */
46 cbreak(); /* Disable line buffering. */
47 noecho(); /* Disable getch() echo. */
48 keypad(stdscr, TRUE); /* Enable num keypad keys. */
49 nonl(); /* Disable new-line translation. */
50 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
51 curs_set(0); /* Make cursor invisible */
52 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
54 /* We may be operating with an incorrect $TERM type; in this case
55 * the keymappings will be slightly broken. We want at least
56 * backspace to work though, so we'll define both DEL and ^H to
58 define_key("\x7f", KEY_BACKSPACE);
59 define_key("\x08", KEY_BACKSPACE);
61 /* we need backtab too, for form navigation. vt220 doesn't include
62 * this (kcbt), but we don't want to require a full linux/xterm termcap
64 define_key("\x1b[Z", KEY_BTAB);
66 while (getch() != ERR) /* flush stdin */
70 static void cui_atexit(void)
78 * cui_abort - Signal the main cui program loop to exit.
80 * Sets cui.abort, which causes the cui_run() routine to return.
83 void cui_abort(struct cui *cui)
85 pb_log("%s: exiting\n", __func__);
90 * cui_resize - Signal the main cui program loop to resize
95 void cui_resize(struct cui *cui)
97 pb_debug("%s: resizing\n", __func__);
102 * cui_on_exit - A generic main menu exit callback.
105 void cui_on_exit(struct pmenu *menu)
107 cui_abort(cui_from_pmenu(menu));
111 * cui_run_cmd - A generic cb to run the supplied command.
114 int cui_run_cmd(struct pmenu_item *item)
117 struct cui *cui = cui_from_item(item);
118 const char **cmd_argv = item->data;
120 nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
124 result = process_run_simple_argv(item, cmd_argv);
127 redrawwin(cui->current->main_ncw);
130 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
131 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
138 * cui_boot - A generic cb to run kexec.
141 static int cui_boot(struct pmenu_item *item)
144 struct cui *cui = cui_from_item(item);
145 struct cui_opt_data *cod = cod_from_item(item);
147 assert(cui->current == &cui->main->scr);
149 pb_debug("%s: %s\n", __func__, cod->name);
151 nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
153 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
156 nc_scr_status_printf(cui->current,
157 "Failed: boot %s", cod->bd->image);
163 static void cui_boot_editor_on_exit(struct cui *cui,
164 struct pmenu_item *item,
165 struct pb_boot_data *bd)
167 struct pmenu *menu = cui->main;
168 struct cui_opt_data *cod;
169 static int user_idx = 0;
171 /* Was the edit cancelled? */
173 cui_set_current(cui, &cui->main->scr);
174 talloc_free(cui->boot_editor);
175 cui->boot_editor = NULL;
179 /* Is this was a new item, we'll need to update the menu */
183 cod = talloc_zero(NULL, struct cui_opt_data);
184 cod->name = talloc_asprintf(cod, "User item %u", ++user_idx);
186 item = pmenu_item_create(menu, cod->name);
192 item->on_edit = cui_item_edit;
193 item->on_execute = cui_boot;
196 talloc_steal(item, cod);
198 /* Detach the items array. */
199 set_menu_items(menu->ncm, NULL);
201 /* Insert new item at insert_pt. */
202 insert_pt = pmenu_grow(menu, 1);
203 pmenu_item_insert(menu, item, insert_pt);
205 /* Re-attach the items array. */
206 set_menu_items(menu->ncm, menu->items);
207 nc_scr_post(&menu->scr);
212 cod->bd = talloc_steal(cod, bd);
214 set_current_item(item->pmenu->ncm, item->nci);
216 cui_set_current(cui, &cui->main->scr);
217 talloc_free(cui->boot_editor);
218 cui->boot_editor = NULL;
221 void cui_item_edit(struct pmenu_item *item)
223 struct cui *cui = cui_from_item(item);
224 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
225 cui_boot_editor_on_exit);
226 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
229 void cui_item_new(struct pmenu *menu)
231 struct cui *cui = cui_from_pmenu(menu);
232 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
233 cui_boot_editor_on_exit);
234 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
237 static void cui_sysinfo_exit(struct cui *cui)
239 cui_set_current(cui, &cui->main->scr);
240 talloc_free(cui->sysinfo_screen);
241 cui->sysinfo_screen = NULL;
244 void cui_show_sysinfo(struct cui *cui)
246 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
248 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
251 static void cui_config_exit(struct cui *cui)
253 cui_set_current(cui, &cui->main->scr);
254 talloc_free(cui->config_screen);
255 cui->config_screen = NULL;
258 void cui_show_config(struct cui *cui)
260 cui->config_screen = config_screen_init(cui, cui->config,
261 cui->sysinfo, cui_config_exit);
262 cui_set_current(cui, config_screen_scr(cui->config_screen));
265 static void cui_help_exit(struct cui *cui)
267 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
268 talloc_free(cui->help_screen);
269 cui->help_screen = NULL;
272 void cui_show_help(struct cui *cui, const char *title, const char *text)
277 if (cui->help_screen)
280 cui->help_screen = help_screen_init(cui, cui->current,
281 title, text, cui_help_exit);
283 if (cui->help_screen)
284 cui_set_current(cui, help_screen_scr(cui->help_screen));
288 * cui_set_current - Set the currently active screen and redraw it.
291 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
295 DBGS("%p -> %p\n", cui->current, scr);
297 assert(cui->current != scr);
304 nc_scr_post(cui->current);
309 static bool process_global_keys(struct cui *cui, int key)
313 if (cui->current && cui->current->main_ncw)
321 * cui_process_key - Process input on stdin.
324 static int cui_process_key(void *arg)
326 struct cui *cui = cui_from_arg(arg);
328 assert(cui->current);
333 pb_debug("%s: got key %d\n", __func__, c);
338 if (!cui->has_input) {
339 pb_log("UI input received (key = %d), aborting "
340 "default boot\n", c);
341 discover_client_cancel_default(cui->client);
342 cui->has_input = true;
345 if (process_global_keys(cui, c))
348 cui->current->process_key(cui->current, c);
355 * cui_process_js - Process joystick events.
358 static int cui_process_js(void *arg)
360 struct cui *cui = cui_from_arg(arg);
363 c = pjs_process_event(cui->pjs);
367 cui_process_key(arg);
374 * cui_handle_resize - Handle the term resize.
377 static void cui_handle_resize(struct cui *cui)
381 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
382 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
386 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
388 wclear(cui->current->main_ncw);
389 resize_term(ws.ws_row, ws.ws_col);
390 cui->current->resize(cui->current);
392 /* For some reason this makes ncurses redraw the screen */
394 redrawwin(cui->current->main_ncw);
395 wrefresh(cui->current->main_ncw);
399 * cui_device_add - Client device_add callback.
401 * Creates menu_items for all the device boot_options and inserts those
402 * menu_items into the main menu. Redraws the main menu if it is active.
405 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
408 struct cui *cui = cui_from_arg(arg);
409 struct cui_opt_data *cod;
410 unsigned int insert_pt;
411 int result, rows, cols;
412 struct pmenu_item *i;
415 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
417 selected = current_item(cui->main->ncm);
418 menu_format(cui->main->ncm, &rows, &cols);
420 if (cui->current == &cui->main->scr)
421 nc_scr_unpost(cui->current);
423 /* Save the item in opt->ui_info for cui_device_remove() */
425 opt->ui_info = i = pmenu_item_create(cui->main, opt->name);
429 i->on_edit = cui_item_edit;
430 i->on_execute = cui_boot;
431 i->data = cod = talloc(i, struct cui_opt_data);
435 cod->opt_hash = pb_opt_hash(dev, opt);
436 cod->name = opt->name;
437 cod->bd = talloc(i, struct pb_boot_data);
439 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
440 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
441 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
442 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
444 /* This disconnects items array from menu. */
445 result = set_menu_items(cui->main->ncm, NULL);
448 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
450 /* Insert new items at insert_pt. */
451 insert_pt = pmenu_grow(cui->main, 1);
452 pmenu_item_insert(cui->main, i, insert_pt);
454 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
455 pb_log(" image '%s'\n", cod->bd->image);
456 pb_log(" initrd '%s'\n", cod->bd->initrd);
457 pb_log(" args '%s'\n", cod->bd->args);
459 /* Re-attach the items array. */
460 result = set_menu_items(cui->main->ncm, cui->main->items);
463 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
466 pb_log("%s\n", __func__);
467 pmenu_dump_items(cui->main->items,
468 item_count(cui->main->ncm) + 1);
471 if (!item_visible(selected)) {
474 top = top_row(cui->main->ncm);
475 idx = item_index(selected);
477 /* If our index is above the current top row, align
478 * us to the new top. Otherwise, align us to the new
480 top = top < idx ? idx - rows : idx;
482 set_top_row(cui->main->ncm, top);
483 set_current_item(cui->main->ncm, selected);
486 if (cui->current == &cui->main->scr)
487 nc_scr_post(cui->current);
493 * cui_device_remove - Client device remove callback.
495 * Removes all the menu_items for the device from the main menu and redraws the
496 * main menu if it is active.
499 static void cui_device_remove(struct device *dev, void *arg)
501 struct cui *cui = cui_from_arg(arg);
503 struct boot_option *opt;
505 pb_log("%s: %p %s\n", __func__, dev, dev->id);
507 if (cui->current == &cui->main->scr)
508 nc_scr_unpost(cui->current);
510 /* This disconnects items array from menu. */
512 result = set_menu_items(cui->main->ncm, NULL);
515 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
517 list_for_each_entry(&dev->boot_options, opt, list) {
518 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
520 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
521 pmenu_remove(cui->main, i);
524 /* Re-attach the items array. */
526 result = set_menu_items(cui->main->ncm, cui->main->items);
529 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
532 pb_log("%s\n", __func__);
533 pmenu_dump_items(cui->main->items,
534 item_count(cui->main->ncm) + 1);
537 if (cui->current == &cui->main->scr)
538 nc_scr_post(cui->current);
541 static void cui_update_status(struct boot_status *status, void *arg)
543 struct cui *cui = cui_from_arg(arg);
545 nc_scr_status_printf(cui->current,
547 status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
552 static void cui_update_mm_title(struct cui *cui)
554 struct nc_frame *frame = &cui->main->scr.frame;
556 talloc_free(frame->rtitle);
558 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
559 if (cui->sysinfo->identifier)
560 frame->rtitle = talloc_asprintf_append(frame->rtitle,
561 " %s", cui->sysinfo->identifier);
563 if (cui->current == &cui->main->scr)
564 nc_scr_post(cui->current);
567 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
569 struct cui *cui = cui_from_arg(arg);
570 cui->sysinfo = talloc_steal(cui, sysinfo);
572 /* if we're currently displaying the system info screen, inform it
573 * of the updated information. */
574 if (cui->sysinfo_screen)
575 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
577 /* ... and do the same with the config screen... */
578 if (cui->config_screen)
579 config_screen_update(cui->config_screen, cui->config, sysinfo);
581 /* ... and the boot editor. */
582 if (cui->boot_editor)
583 boot_editor_update(cui->boot_editor, sysinfo);
585 cui_update_mm_title(cui);
588 static void cui_update_config(struct config *config, void *arg)
590 struct cui *cui = cui_from_arg(arg);
591 cui->config = talloc_steal(cui, config);
593 if (cui->config_screen)
594 config_screen_update(cui->config_screen, config, cui->sysinfo);
597 int cui_send_config(struct cui *cui, struct config *config)
599 return discover_client_send_config(cui->client, config);
602 void cui_send_reinit(struct cui *cui)
604 discover_client_send_reinit(cui->client);
607 static struct discover_client_ops cui_client_ops = {
609 .boot_option_add = cui_boot_option_add,
610 .device_remove = cui_device_remove,
611 .update_status = cui_update_status,
612 .update_sysinfo = cui_update_sysinfo,
613 .update_config = cui_update_config,
617 * cui_init - Setup the cui instance.
618 * @platform_info: A value for the struct cui platform_info member.
620 * Returns a pointer to a struct cui on success, or NULL on error.
622 * Allocates the cui instance, sets up the client and stdin waiters, and
623 * sets up the ncurses menu screen.
626 struct cui *cui_init(void* platform_info,
627 int (*js_map)(const struct js_event *e), int start_deamon)
632 cui = talloc_zero(NULL, struct cui);
635 pb_log("%s: alloc cui failed.\n", __func__);
636 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
640 cui->c_sig = pb_cui_sig;
641 cui->platform_info = platform_info;
642 cui->waitset = waitset_create(cui);
644 process_init(cui, cui->waitset, false);
646 setlocale(LC_ALL, "");
648 /* Loop here for scripts that just started the server. */
651 for (i = start_deamon ? 2 : 10; i; i--) {
652 cui->client = discover_client_init(cui->waitset,
653 &cui_client_ops, cui);
654 if (cui->client || !i)
656 pb_log("%s: waiting for server %d\n", __func__, i);
660 if (!cui->client && start_deamon) {
665 result = pb_start_daemon(cui);
670 pb_log("%s: discover_client_init failed.\n", __func__);
671 fprintf(stderr, "%s: error: discover_client_init failed.\n",
673 fprintf(stderr, "could not start pb-discover, the petitboot "
675 goto fail_client_init;
679 pb_log("%s: discover_client_init failed.\n", __func__);
680 fprintf(stderr, "%s: error: discover_client_init failed.\n",
682 fprintf(stderr, "check that pb-discover, "
683 "the petitboot daemon is running.\n");
684 goto fail_client_init;
688 talloc_steal(cui, cui->client);
691 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
692 cui_process_key, cui);
696 cui->pjs = pjs_init(cui, js_map);
699 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
700 WAIT_IN, cui_process_js, cui);
712 * cui_run - The main cui program loop.
713 * @cui: The cui instance.
714 * @main: The menu to use as the main menu.
716 * Runs the cui engine. Does not return until indicated to do so by some
717 * user action, or an error occurs. Frees the cui object on return.
718 * Returns 0 on success (return to shell), -1 on error (should restart).
721 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
726 cui->current = &cui->main->scr;
727 cui->default_item = default_item;
729 nc_scr_post(cui->current);
732 int result = waiter_poll(cui->waitset);
735 pb_log("%s: poll: %s\n", __func__, strerror(errno));
742 while (cui->resize) {
744 cui_handle_resize(cui);
750 return cui->abort ? 0 : -1;