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)
27 #include <sys/ioctl.h>
30 #include "pb-protocol/pb-protocol.h"
31 #include "talloc/talloc.h"
32 #include "waiter/waiter.h"
33 #include "process/process.h"
34 #include "ui/common/discover-client.h"
35 #include "ui/common/ui-system.h"
37 #include "nc-boot-editor.h"
38 #include "nc-config.h"
39 #include "nc-sysinfo.h"
40 #include "nc-helpscreen.h"
42 static void cui_start(void)
44 initscr(); /* Initialize ncurses. */
45 cbreak(); /* Disable line buffering. */
46 noecho(); /* Disable getch() echo. */
47 keypad(stdscr, TRUE); /* Enable num keypad keys. */
48 nonl(); /* Disable new-line translation. */
49 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
50 curs_set(0); /* Make cursor invisible */
51 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
53 /* We may be operating with an incorrect $TERM type; in this case
54 * the keymappings will be slightly broken. We want at least
55 * backspace to work though, so we'll define both DEL and ^H to
57 define_key("\x7f", KEY_BACKSPACE);
58 define_key("\x08", KEY_BACKSPACE);
60 /* we need backtab too, for form navigation. vt220 doesn't include
61 * this (kcbt), but we don't want to require a full linux/xterm termcap
63 define_key("\x1b[Z", KEY_BTAB);
65 while (getch() != ERR) /* flush stdin */
69 static void cui_atexit(void)
77 * cui_abort - Signal the main cui program loop to exit.
79 * Sets cui.abort, which causes the cui_run() routine to return.
82 void cui_abort(struct cui *cui)
84 pb_log("%s: exiting\n", __func__);
89 * cui_resize - Signal the main cui program loop to resize
94 void cui_resize(struct cui *cui)
96 pb_debug("%s: resizing\n", __func__);
101 * cui_on_exit - A generic main menu exit callback.
104 void cui_on_exit(struct pmenu *menu)
106 cui_abort(cui_from_pmenu(menu));
110 * cui_run_cmd - A generic cb to run the supplied command.
113 int cui_run_cmd(struct pmenu_item *item)
116 struct cui *cui = cui_from_item(item);
117 const char **cmd_argv = item->data;
119 nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
123 result = process_run_simple_argv(item, cmd_argv);
126 redrawwin(cui->current->main_ncw);
129 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
130 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
137 * cui_boot - A generic cb to run kexec.
140 static int cui_boot(struct pmenu_item *item)
143 struct cui *cui = cui_from_item(item);
144 struct cui_opt_data *cod = cod_from_item(item);
146 assert(cui->current == &cui->main->scr);
148 pb_debug("%s: %s\n", __func__, cod->name);
150 nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
152 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
155 nc_scr_status_printf(cui->current,
156 "Failed: boot %s", cod->bd->image);
162 static void cui_boot_editor_on_exit(struct cui *cui,
163 struct pmenu_item *item,
164 struct pb_boot_data *bd)
166 struct pmenu *menu = cui->main;
167 struct cui_opt_data *cod;
168 static int user_idx = 0;
170 /* Was the edit cancelled? */
172 cui_set_current(cui, &cui->main->scr);
173 talloc_free(cui->boot_editor);
174 cui->boot_editor = NULL;
178 /* Is this was a new item, we'll need to update the menu */
182 cod = talloc_zero(NULL, struct cui_opt_data);
183 cod->name = talloc_asprintf(cod, "User item %u", ++user_idx);
185 item = pmenu_item_create(menu, cod->name);
191 item->on_edit = cui_item_edit;
192 item->on_execute = cui_boot;
195 talloc_steal(item, cod);
197 /* Detach the items array. */
198 set_menu_items(menu->ncm, NULL);
200 /* Insert new item at insert_pt. */
201 insert_pt = pmenu_grow(menu, 1);
202 pmenu_item_insert(menu, item, insert_pt);
204 /* Re-attach the items array. */
205 set_menu_items(menu->ncm, menu->items);
206 nc_scr_post(&menu->scr);
211 cod->bd = talloc_steal(cod, bd);
213 set_current_item(item->pmenu->ncm, item->nci);
215 cui_set_current(cui, &cui->main->scr);
216 talloc_free(cui->boot_editor);
217 cui->boot_editor = NULL;
220 void cui_item_edit(struct pmenu_item *item)
222 struct cui *cui = cui_from_item(item);
223 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
224 cui_boot_editor_on_exit);
225 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
228 void cui_item_new(struct pmenu *menu)
230 struct cui *cui = cui_from_pmenu(menu);
231 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
232 cui_boot_editor_on_exit);
233 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
236 static void cui_sysinfo_exit(struct cui *cui)
238 cui_set_current(cui, &cui->main->scr);
239 talloc_free(cui->sysinfo_screen);
240 cui->sysinfo_screen = NULL;
243 void cui_show_sysinfo(struct cui *cui)
245 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
247 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
250 static void cui_config_exit(struct cui *cui)
252 cui_set_current(cui, &cui->main->scr);
253 talloc_free(cui->config_screen);
254 cui->config_screen = NULL;
257 void cui_show_config(struct cui *cui)
259 cui->config_screen = config_screen_init(cui, cui->config,
260 cui->sysinfo, cui_config_exit);
261 cui_set_current(cui, config_screen_scr(cui->config_screen));
264 static void cui_help_exit(struct cui *cui)
266 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
267 talloc_free(cui->help_screen);
268 cui->help_screen = NULL;
271 void cui_show_help(struct cui *cui, const char *title, const char *text)
276 if (cui->help_screen)
279 cui->help_screen = help_screen_init(cui, cui->current,
280 title, text, cui_help_exit);
282 if (cui->help_screen)
283 cui_set_current(cui, help_screen_scr(cui->help_screen));
287 * cui_set_current - Set the currently active screen and redraw it.
290 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
294 DBGS("%p -> %p\n", cui->current, scr);
296 assert(cui->current != scr);
303 nc_scr_post(cui->current);
308 static bool process_global_keys(struct cui *cui, int key)
312 if (cui->current && cui->current->main_ncw)
320 * cui_process_key - Process input on stdin.
323 static int cui_process_key(void *arg)
325 struct cui *cui = cui_from_arg(arg);
327 assert(cui->current);
332 pb_debug("%s: got key %d\n", __func__, c);
337 if (!cui->has_input) {
338 pb_log("UI input received (key = %d), aborting "
339 "default boot\n", c);
340 discover_client_cancel_default(cui->client);
341 cui->has_input = true;
344 if (process_global_keys(cui, c))
347 cui->current->process_key(cui->current, c);
354 * cui_process_js - Process joystick events.
357 static int cui_process_js(void *arg)
359 struct cui *cui = cui_from_arg(arg);
362 c = pjs_process_event(cui->pjs);
366 cui_process_key(arg);
373 * cui_handle_resize - Handle the term resize.
376 static void cui_handle_resize(struct cui *cui)
380 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
381 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
385 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
387 wclear(cui->current->main_ncw);
388 resize_term(ws.ws_row, ws.ws_col);
389 cui->current->resize(cui->current);
391 /* For some reason this makes ncurses redraw the screen */
393 redrawwin(cui->current->main_ncw);
394 wrefresh(cui->current->main_ncw);
398 * cui_device_add - Client device_add callback.
400 * Creates menu_items for all the device boot_options and inserts those
401 * menu_items into the main menu. Redraws the main menu if it is active.
404 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
407 struct pmenu_item *i, *dev_hdr = NULL;
408 struct cui *cui = cui_from_arg(arg);
409 struct cui_opt_data *cod;
410 const char *tab = " ";
411 unsigned int insert_pt;
412 int result, rows, cols;
416 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
418 selected = current_item(cui->main->ncm);
419 menu_format(cui->main->ncm, &rows, &cols);
421 if (cui->current == &cui->main->scr)
422 nc_scr_unpost(cui->current);
424 /* Check if the boot device is new */
425 dev_hdr = pmenu_find_device(cui->main, dev, opt);
427 /* All actual boot entries are 'tabbed' across */
428 name = talloc_asprintf(cui->main, "%s%s",
429 tab, opt->name ? : "Unknown Name");
431 /* Save the item in opt->ui_info for cui_device_remove() */
432 opt->ui_info = i = pmenu_item_create(cui->main, name);
437 i->on_edit = cui_item_edit;
438 i->on_execute = cui_boot;
439 i->data = cod = talloc(i, struct cui_opt_data);
443 cod->opt_hash = pb_opt_hash(dev, opt);
444 cod->name = opt->name;
445 cod->bd = talloc(i, struct pb_boot_data);
447 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
448 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
449 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
450 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
452 /* This disconnects items array from menu. */
453 result = set_menu_items(cui->main->ncm, NULL);
456 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
458 /* Insert new items at insert_pt. */
460 insert_pt = pmenu_grow(cui->main, 2);
461 pmenu_item_insert(cui->main, dev_hdr, insert_pt);
462 pb_log("%s: adding new device hierarchy %s\n",
463 __func__,opt->device_id);
464 pmenu_item_insert(cui->main, i, insert_pt+1);
466 insert_pt = pmenu_grow(cui->main, 1);
467 pmenu_item_add(cui->main, i, insert_pt);
470 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
471 pb_log(" image '%s'\n", cod->bd->image);
472 pb_log(" initrd '%s'\n", cod->bd->initrd);
473 pb_log(" args '%s'\n", cod->bd->args);
475 /* Re-attach the items array. */
476 result = set_menu_items(cui->main->ncm, cui->main->items);
479 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
482 pb_log("%s\n", __func__);
483 pmenu_dump_items(cui->main->items,
484 item_count(cui->main->ncm) + 1);
487 if (!item_visible(selected)) {
490 top = top_row(cui->main->ncm);
491 idx = item_index(selected);
493 /* If our index is above the current top row, align
494 * us to the new top. Otherwise, align us to the new
496 top = top < idx ? idx - rows : idx;
498 set_top_row(cui->main->ncm, top);
499 set_current_item(cui->main->ncm, selected);
502 if (cui->current == &cui->main->scr)
503 nc_scr_post(cui->current);
509 * cui_device_remove - Client device remove callback.
511 * Removes all the menu_items for the device from the main menu and redraws the
512 * main menu if it is active.
515 static void cui_device_remove(struct device *dev, void *arg)
517 struct cui *cui = cui_from_arg(arg);
518 struct boot_option *opt;
522 pb_log("%s: %p %s\n", __func__, dev, dev->id);
524 if (cui->current == &cui->main->scr)
525 nc_scr_unpost(cui->current);
527 /* This disconnects items array from menu. */
529 result = set_menu_items(cui->main->ncm, NULL);
532 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
534 list_for_each_entry(&dev->boot_options, opt, list) {
535 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
537 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
538 pmenu_remove(cui->main, item);
541 /* Manually remove remaining device hierarchy item */
542 for (i=0; i < cui->main->item_count; i++) {
543 struct pmenu_item *item = item_userptr(cui->main->items[i]);
544 if (!item || !item->data )
547 struct cui_opt_data *data = item->data;
548 if (data && data->dev && data->dev == dev)
549 pmenu_remove(cui->main,item);
552 /* Re-attach the items array. */
554 result = set_menu_items(cui->main->ncm, cui->main->items);
557 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
560 pb_log("%s\n", __func__);
561 pmenu_dump_items(cui->main->items,
562 item_count(cui->main->ncm) + 1);
565 if (cui->current == &cui->main->scr)
566 nc_scr_post(cui->current);
569 static void cui_update_status(struct boot_status *status, void *arg)
571 struct cui *cui = cui_from_arg(arg);
573 nc_scr_status_printf(cui->current,
575 status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
580 static void cui_update_mm_title(struct cui *cui)
582 struct nc_frame *frame = &cui->main->scr.frame;
584 talloc_free(frame->rtitle);
586 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
587 if (cui->sysinfo->identifier)
588 frame->rtitle = talloc_asprintf_append(frame->rtitle,
589 " %s", cui->sysinfo->identifier);
591 if (cui->current == &cui->main->scr)
592 nc_scr_post(cui->current);
595 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
597 struct cui *cui = cui_from_arg(arg);
598 cui->sysinfo = talloc_steal(cui, sysinfo);
600 /* if we're currently displaying the system info screen, inform it
601 * of the updated information. */
602 if (cui->sysinfo_screen)
603 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
605 /* ... and do the same with the config screen... */
606 if (cui->config_screen)
607 config_screen_update(cui->config_screen, cui->config, sysinfo);
609 /* ... and the boot editor. */
610 if (cui->boot_editor)
611 boot_editor_update(cui->boot_editor, sysinfo);
613 cui_update_mm_title(cui);
616 static void cui_update_config(struct config *config, void *arg)
618 struct cui *cui = cui_from_arg(arg);
619 cui->config = talloc_steal(cui, config);
621 if (cui->config_screen)
622 config_screen_update(cui->config_screen, config, cui->sysinfo);
624 if (config->safe_mode)
625 nc_scr_status_printf(cui->current,
626 "SAFE MODE: select '%s' to continue",
630 int cui_send_config(struct cui *cui, struct config *config)
632 return discover_client_send_config(cui->client, config);
635 void cui_send_reinit(struct cui *cui)
637 discover_client_send_reinit(cui->client);
640 static struct discover_client_ops cui_client_ops = {
642 .boot_option_add = cui_boot_option_add,
643 .device_remove = cui_device_remove,
644 .update_status = cui_update_status,
645 .update_sysinfo = cui_update_sysinfo,
646 .update_config = cui_update_config,
650 * cui_init - Setup the cui instance.
651 * @platform_info: A value for the struct cui platform_info member.
653 * Returns a pointer to a struct cui on success, or NULL on error.
655 * Allocates the cui instance, sets up the client and stdin waiters, and
656 * sets up the ncurses menu screen.
659 struct cui *cui_init(void* platform_info,
660 int (*js_map)(const struct js_event *e), int start_deamon)
665 cui = talloc_zero(NULL, struct cui);
668 pb_log("%s: alloc cui failed.\n", __func__);
669 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
673 cui->c_sig = pb_cui_sig;
674 cui->platform_info = platform_info;
675 cui->waitset = waitset_create(cui);
677 process_init(cui, cui->waitset, false);
679 /* Loop here for scripts that just started the server. */
682 for (i = start_deamon ? 2 : 10; i; i--) {
683 cui->client = discover_client_init(cui->waitset,
684 &cui_client_ops, cui);
685 if (cui->client || !i)
687 pb_log("%s: waiting for server %d\n", __func__, i);
691 if (!cui->client && start_deamon) {
696 result = pb_start_daemon(cui);
701 pb_log("%s: discover_client_init failed.\n", __func__);
702 fprintf(stderr, "%s: error: discover_client_init failed.\n",
704 fprintf(stderr, "could not start pb-discover, the petitboot "
706 goto fail_client_init;
710 pb_log("%s: discover_client_init failed.\n", __func__);
711 fprintf(stderr, "%s: error: discover_client_init failed.\n",
713 fprintf(stderr, "check that pb-discover, "
714 "the petitboot daemon is running.\n");
715 goto fail_client_init;
719 talloc_steal(cui, cui->client);
722 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
723 cui_process_key, cui);
727 cui->pjs = pjs_init(cui, js_map);
730 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
731 WAIT_IN, cui_process_js, cui);
743 * cui_run - The main cui program loop.
744 * @cui: The cui instance.
745 * @main: The menu to use as the main menu.
747 * Runs the cui engine. Does not return until indicated to do so by some
748 * user action, or an error occurs. Frees the cui object on return.
749 * Returns 0 on success (return to shell), -1 on error (should restart).
752 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
757 cui->current = &cui->main->scr;
758 cui->default_item = default_item;
760 nc_scr_post(cui->current);
763 int result = waiter_poll(cui->waitset);
766 pb_log("%s: poll: %s\n", __func__, strerror(errno));
773 while (cui->resize) {
775 cui_handle_resize(cui);
781 return cui->abort ? 0 : -1;