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 "i18n/i18n.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-add-url.h"
41 #include "nc-sysinfo.h"
43 #include "nc-helpscreen.h"
45 extern const struct help_text main_menu_help_text;
47 static struct pmenu *main_menu_init(struct cui *cui);
49 static void cui_start(void)
51 initscr(); /* Initialize ncurses. */
52 cbreak(); /* Disable line buffering. */
53 noecho(); /* Disable getch() echo. */
54 keypad(stdscr, TRUE); /* Enable num keypad keys. */
55 nonl(); /* Disable new-line translation. */
56 intrflush(stdscr, FALSE); /* Disable interrupt flush. */
57 curs_set(0); /* Make cursor invisible */
58 nodelay(stdscr, TRUE); /* Enable non-blocking getch() */
60 /* We may be operating with an incorrect $TERM type; in this case
61 * the keymappings will be slightly broken. We want at least
62 * backspace to work though, so we'll define both DEL and ^H to
64 define_key("\x7f", KEY_BACKSPACE);
65 define_key("\x08", KEY_BACKSPACE);
67 /* we need backtab too, for form navigation. vt220 doesn't include
68 * this (kcbt), but we don't want to require a full linux/xterm termcap
70 define_key("\x1b[Z", KEY_BTAB);
72 while (getch() != ERR) /* flush stdin */
76 static void cui_atexit(void)
84 * cui_abort - Signal the main cui program loop to exit.
86 * Sets cui.abort, which causes the cui_run() routine to return.
89 void cui_abort(struct cui *cui)
91 pb_log("%s: exiting\n", __func__);
96 * cui_resize - Signal the main cui program loop to resize
101 void cui_resize(struct cui *cui)
103 pb_debug("%s: resizing\n", __func__);
108 * cui_on_exit - A generic main menu exit callback.
111 void cui_on_exit(struct pmenu *menu)
113 cui_abort(cui_from_pmenu(menu));
117 * cui_run_cmd - A generic cb to run the supplied command.
120 int cui_run_cmd(struct pmenu_item *item)
123 struct cui *cui = cui_from_item(item);
124 const char **cmd_argv = item->data;
126 nc_scr_status_printf(cui->current, _("Running %s..."), cmd_argv[0]);
130 result = process_run_simple_argv(item, cmd_argv);
133 redrawwin(cui->current->main_ncw);
136 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
137 nc_scr_status_printf(cui->current, _("Failed: %s"),
145 * cui_boot - A generic cb to run kexec.
148 static int cui_boot(struct pmenu_item *item)
151 struct cui *cui = cui_from_item(item);
152 struct cui_opt_data *cod = cod_from_item(item);
154 assert(cui->current == &cui->main->scr);
156 pb_debug("%s: %s\n", __func__, cod->name);
158 nc_scr_status_printf(cui->current, _("Booting %s..."), cod->name);
160 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
163 nc_scr_status_printf(cui->current,
164 _("Failed: boot %s"), cod->bd->image);
170 static void cui_boot_editor_on_exit(struct cui *cui,
171 struct pmenu_item *item,
172 struct pb_boot_data *bd)
174 struct pmenu *menu = cui->main;
175 struct cui_opt_data *cod;
176 static int user_idx = 0;
178 /* Was the edit cancelled? */
180 cui_set_current(cui, &cui->main->scr);
181 talloc_free(cui->boot_editor);
182 cui->boot_editor = NULL;
186 /* Is this was a new item, we'll need to update the menu */
190 cod = talloc_zero(NULL, struct cui_opt_data);
191 cod->name = talloc_asprintf(cod, _("User item %u"), ++user_idx);
193 item = pmenu_item_create(menu, cod->name);
199 item->on_edit = cui_item_edit;
200 item->on_execute = cui_boot;
203 talloc_steal(item, cod);
205 /* Detach the items array. */
206 set_menu_items(menu->ncm, NULL);
208 /* Insert new item at insert_pt. */
209 insert_pt = pmenu_grow(menu, 1);
210 pmenu_item_insert(menu, item, insert_pt);
212 /* Re-attach the items array. */
213 set_menu_items(menu->ncm, menu->items);
214 nc_scr_post(&menu->scr);
219 cod->bd = talloc_steal(cod, bd);
221 set_current_item(item->pmenu->ncm, item->nci);
223 cui_set_current(cui, &cui->main->scr);
224 talloc_free(cui->boot_editor);
225 cui->boot_editor = NULL;
228 void cui_item_edit(struct pmenu_item *item)
230 struct cui *cui = cui_from_item(item);
231 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
232 cui_boot_editor_on_exit);
233 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
236 void cui_item_new(struct pmenu *menu)
238 struct cui *cui = cui_from_pmenu(menu);
239 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
240 cui_boot_editor_on_exit);
241 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
244 static void cui_sysinfo_exit(struct cui *cui)
246 cui_set_current(cui, &cui->main->scr);
247 talloc_free(cui->sysinfo_screen);
248 cui->sysinfo_screen = NULL;
251 void cui_show_sysinfo(struct cui *cui)
253 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
255 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
258 static void cui_config_exit(struct cui *cui)
260 cui_set_current(cui, &cui->main->scr);
261 talloc_free(cui->config_screen);
262 cui->config_screen = NULL;
265 void cui_show_config(struct cui *cui)
267 cui->config_screen = config_screen_init(cui, cui->config,
268 cui->sysinfo, cui_config_exit);
269 cui_set_current(cui, config_screen_scr(cui->config_screen));
272 static void cui_lang_exit(struct cui *cui)
274 cui_set_current(cui, &cui->main->scr);
275 talloc_free(cui->lang_screen);
276 cui->lang_screen = NULL;
279 void cui_show_lang(struct cui *cui)
281 cui->lang_screen = lang_screen_init(cui, cui->config, cui_lang_exit);
282 cui_set_current(cui, lang_screen_scr(cui->lang_screen));
285 static void cui_add_url_exit(struct cui *cui)
287 cui_set_current(cui, &cui->main->scr);
288 talloc_free(cui->add_url_screen);
289 cui->add_url_screen = NULL;
292 void cui_show_add_url(struct cui *cui)
294 cui->add_url_screen = add_url_screen_init(cui, cui_add_url_exit);
295 cui_set_current(cui, add_url_screen_scr(cui->add_url_screen));
298 static void cui_help_exit(struct cui *cui)
300 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
301 talloc_free(cui->help_screen);
302 cui->help_screen = NULL;
305 void cui_show_help(struct cui *cui, const char *title,
306 const struct help_text *text)
311 if (cui->help_screen)
314 cui->help_screen = help_screen_init(cui, cui->current,
315 title, text, cui_help_exit);
317 if (cui->help_screen)
318 cui_set_current(cui, help_screen_scr(cui->help_screen));
322 * cui_set_current - Set the currently active screen and redraw it.
325 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
329 DBGS("%p -> %p\n", cui->current, scr);
331 assert(cui->current != scr);
338 nc_scr_post(cui->current);
343 static bool process_global_keys(struct cui *cui, int key)
347 if (cui->current && cui->current->main_ncw)
355 * cui_process_key - Process input on stdin.
358 static int cui_process_key(void *arg)
360 struct cui *cui = cui_from_arg(arg);
362 assert(cui->current);
367 pb_debug("%s: got key %d\n", __func__, c);
372 if (!cui->has_input) {
373 pb_log("UI input received (key = %d), aborting "
374 "default boot\n", c);
375 discover_client_cancel_default(cui->client);
376 cui->has_input = true;
379 if (process_global_keys(cui, c))
382 cui->current->process_key(cui->current, c);
389 * cui_process_js - Process joystick events.
392 static int cui_process_js(void *arg)
394 struct cui *cui = cui_from_arg(arg);
397 c = pjs_process_event(cui->pjs);
401 cui_process_key(arg);
408 * cui_handle_resize - Handle the term resize.
411 static void cui_handle_resize(struct cui *cui)
415 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
416 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
420 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
422 wclear(cui->current->main_ncw);
423 resize_term(ws.ws_row, ws.ws_col);
424 cui->current->resize(cui->current);
426 /* For some reason this makes ncurses redraw the screen */
428 redrawwin(cui->current->main_ncw);
429 wrefresh(cui->current->main_ncw);
433 * cui_device_add - Client device_add callback.
435 * Creates menu_items for all the device boot_options and inserts those
436 * menu_items into the main menu. Redraws the main menu if it is active.
439 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
442 struct pmenu_item *i, *dev_hdr = NULL;
443 struct cui *cui = cui_from_arg(arg);
444 struct cui_opt_data *cod;
445 const char *tab = " ";
446 unsigned int insert_pt;
447 int result, rows, cols;
451 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
453 selected = current_item(cui->main->ncm);
454 menu_format(cui->main->ncm, &rows, &cols);
456 if (cui->current == &cui->main->scr)
457 nc_scr_unpost(cui->current);
459 /* Check if the boot device is new */
460 dev_hdr = pmenu_find_device(cui->main, dev, opt);
462 /* All actual boot entries are 'tabbed' across */
463 name = talloc_asprintf(cui->main, "%s%s",
464 tab, opt->name ? : "Unknown Name");
466 /* Save the item in opt->ui_info for cui_device_remove() */
467 opt->ui_info = i = pmenu_item_create(cui->main, name);
472 i->on_edit = cui_item_edit;
473 i->on_execute = cui_boot;
474 i->data = cod = talloc(i, struct cui_opt_data);
478 cod->opt_hash = pb_opt_hash(dev, opt);
479 cod->name = opt->name;
480 cod->bd = talloc(i, struct pb_boot_data);
482 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
483 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
484 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
485 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
487 /* This disconnects items array from menu. */
488 result = set_menu_items(cui->main->ncm, NULL);
491 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
493 /* Insert new items at insert_pt. */
495 insert_pt = pmenu_grow(cui->main, 2);
496 pmenu_item_insert(cui->main, dev_hdr, insert_pt);
497 pb_log("%s: adding new device hierarchy %s\n",
498 __func__,opt->device_id);
499 pmenu_item_insert(cui->main, i, insert_pt+1);
501 insert_pt = pmenu_grow(cui->main, 1);
502 pmenu_item_add(cui->main, i, insert_pt);
505 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
506 pb_log(" image '%s'\n", cod->bd->image);
507 pb_log(" initrd '%s'\n", cod->bd->initrd);
508 pb_log(" args '%s'\n", cod->bd->args);
510 /* Re-attach the items array. */
511 result = set_menu_items(cui->main->ncm, cui->main->items);
514 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
517 pb_log("%s\n", __func__);
518 pmenu_dump_items(cui->main->items,
519 item_count(cui->main->ncm) + 1);
522 if (!item_visible(selected)) {
525 top = top_row(cui->main->ncm);
526 idx = item_index(selected);
528 /* If our index is above the current top row, align
529 * us to the new top. Otherwise, align us to the new
531 top = top < idx ? idx - rows : idx;
533 set_top_row(cui->main->ncm, top);
534 set_current_item(cui->main->ncm, selected);
537 if (cui->current == &cui->main->scr)
538 nc_scr_post(cui->current);
544 * cui_device_remove - Client device remove callback.
546 * Removes all the menu_items for the device from the main menu and redraws the
547 * main menu if it is active.
550 static void cui_device_remove(struct device *dev, void *arg)
552 struct cui *cui = cui_from_arg(arg);
553 struct boot_option *opt;
557 pb_log("%s: %p %s\n", __func__, dev, dev->id);
559 if (cui->current == &cui->main->scr)
560 nc_scr_unpost(cui->current);
562 /* This disconnects items array from menu. */
564 result = set_menu_items(cui->main->ncm, NULL);
567 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
569 list_for_each_entry(&dev->boot_options, opt, list) {
570 struct pmenu_item *item = pmenu_item_from_arg(opt->ui_info);
572 assert(pb_protocol_device_cmp(dev, cod_from_item(item)->dev));
573 pmenu_remove(cui->main, item);
576 /* Manually remove remaining device hierarchy item */
577 for (i=0; i < cui->main->item_count; i++) {
578 struct pmenu_item *item = item_userptr(cui->main->items[i]);
579 if (!item || !item->data )
582 struct cui_opt_data *data = item->data;
583 if (data && data->dev && data->dev == dev)
584 pmenu_remove(cui->main,item);
587 /* Re-attach the items array. */
589 result = set_menu_items(cui->main->ncm, cui->main->items);
592 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
595 pb_log("%s\n", __func__);
596 pmenu_dump_items(cui->main->items,
597 item_count(cui->main->ncm) + 1);
600 if (cui->current == &cui->main->scr)
601 nc_scr_post(cui->current);
604 static void cui_update_status(struct boot_status *status, void *arg)
606 struct cui *cui = cui_from_arg(arg);
608 nc_scr_status_printf(cui->current,
610 status->type == BOOT_STATUS_ERROR ?
611 _("Error") : _("Info"),
616 static void cui_update_mm_title(struct cui *cui)
618 struct nc_frame *frame = &cui->main->scr.frame;
620 talloc_free(frame->rtitle);
622 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
623 if (cui->sysinfo->identifier)
624 frame->rtitle = talloc_asprintf_append(frame->rtitle,
625 " %s", cui->sysinfo->identifier);
627 if (cui->current == &cui->main->scr)
628 nc_scr_post(cui->current);
631 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
633 struct cui *cui = cui_from_arg(arg);
634 cui->sysinfo = talloc_steal(cui, sysinfo);
636 /* if we're currently displaying the system info screen, inform it
637 * of the updated information. */
638 if (cui->sysinfo_screen)
639 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
641 /* ... and do the same with the config screen... */
642 if (cui->config_screen)
643 config_screen_update(cui->config_screen, cui->config, sysinfo);
645 /* ... and the boot editor. */
646 if (cui->boot_editor)
647 boot_editor_update(cui->boot_editor, sysinfo);
649 cui_update_mm_title(cui);
652 static void cui_update_language(struct cui *cui, char *lang)
657 cur_lang = setlocale(LC_ALL, NULL);
658 if (cur_lang && !strcmp(cur_lang, lang))
661 setlocale(LC_ALL, lang);
663 /* we'll need to update the menu: drop all items and repopulate */
664 repost_menu = cui->current == &cui->main->scr;
666 nc_scr_unpost(cui->current);
668 talloc_free(cui->main);
669 cui->main = main_menu_init(cui);
672 cui->current = &cui->main->scr;
673 nc_scr_post(cui->current);
676 discover_client_enumerate(cui->client);
679 static void cui_update_config(struct config *config, void *arg)
681 struct cui *cui = cui_from_arg(arg);
682 cui->config = talloc_steal(cui, config);
685 cui_update_language(cui, config->lang);
687 if (cui->config_screen)
688 config_screen_update(cui->config_screen, config, cui->sysinfo);
690 if (config->safe_mode)
691 nc_scr_status_printf(cui->current,
692 _("SAFE MODE: select '%s' to continue"),
693 _("Rescan devices"));
696 int cui_send_config(struct cui *cui, struct config *config)
698 return discover_client_send_config(cui->client, config);
701 int cui_send_url(struct cui *cui, char * url)
703 return discover_client_send_url(cui->client, url);
706 void cui_send_reinit(struct cui *cui)
708 discover_client_send_reinit(cui->client);
711 static int menu_sysinfo_execute(struct pmenu_item *item)
713 cui_show_sysinfo(cui_from_item(item));
717 static int menu_config_execute(struct pmenu_item *item)
719 cui_show_config(cui_from_item(item));
723 static int menu_lang_execute(struct pmenu_item *item)
725 cui_show_lang(cui_from_item(item));
729 static int menu_reinit_execute(struct pmenu_item *item)
731 cui_send_reinit(cui_from_item(item));
735 static int menu_add_url_execute(struct pmenu_item *item)
737 cui_show_add_url(cui_from_item(item));
742 * pb_mm_init - Setup the main menu instance.
744 static struct pmenu *main_menu_init(struct cui *cui)
746 struct pmenu_item *i;
750 m = pmenu_init(cui, 7, cui_on_exit);
752 pb_log("%s: failed\n", __func__);
756 m->on_new = cui_item_new;
758 m->scr.frame.ltitle = talloc_asprintf(m,
759 "Petitboot (" PACKAGE_VERSION ")");
760 m->scr.frame.rtitle = NULL;
761 m->scr.frame.help = talloc_strdup(m,
762 _("Enter=accept, e=edit, n=new, x=exit, l=language, h=help"));
763 m->scr.frame.status = talloc_strdup(m, _("Welcome to Petitboot"));
765 /* add a separator */
766 i = pmenu_item_create(m, " ");
767 item_opts_off(i->nci, O_SELECTABLE);
768 pmenu_item_insert(m, i, 0);
770 /* add system items */
771 i = pmenu_item_create(m, _("System information"));
772 i->on_execute = menu_sysinfo_execute;
773 pmenu_item_insert(m, i, 1);
775 i = pmenu_item_create(m, _("System configuration"));
776 i->on_execute = menu_config_execute;
777 pmenu_item_insert(m, i, 2);
779 /* this label isn't translated, so we don't want a gettext() here */
780 i = pmenu_item_create(m, "Language");
781 i->on_execute = menu_lang_execute;
782 pmenu_item_insert(m, i, 3);
784 i = pmenu_item_create(m, _("Rescan devices"));
785 i->on_execute = menu_reinit_execute;
786 pmenu_item_insert(m, i, 4);
788 i = pmenu_item_create(m, _("Retrieve config from URL"));
789 i->on_execute = menu_add_url_execute;
790 pmenu_item_insert(m, i, 5);
792 i = pmenu_item_create(m, _("Exit to shell"));
793 i->on_execute = pmenu_exit_cb;
794 pmenu_item_insert(m, i, 6);
796 result = pmenu_setup(m);
799 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
804 m->help_title = _("main menu");
805 m->help_text = &main_menu_help_text;
807 menu_opts_off(m->ncm, O_SHOWDESC);
808 set_menu_mark(m->ncm, " *");
809 set_current_item(m->ncm, i->nci);
818 static struct discover_client_ops cui_client_ops = {
820 .boot_option_add = cui_boot_option_add,
821 .device_remove = cui_device_remove,
822 .update_status = cui_update_status,
823 .update_sysinfo = cui_update_sysinfo,
824 .update_config = cui_update_config,
828 * cui_init - Setup the cui instance.
829 * @platform_info: A value for the struct cui platform_info member.
831 * Returns a pointer to a struct cui on success, or NULL on error.
833 * Allocates the cui instance, sets up the client and stdin waiters, and
834 * sets up the ncurses menu screen.
837 struct cui *cui_init(void* platform_info,
838 int (*js_map)(const struct js_event *e), int start_deamon)
843 cui = talloc_zero(NULL, struct cui);
845 pb_log("%s: alloc cui failed.\n", __func__);
846 fprintf(stderr, _("%s: alloc cui failed.\n"), __func__);
850 cui->c_sig = pb_cui_sig;
851 cui->platform_info = platform_info;
852 cui->waitset = waitset_create(cui);
854 process_init(cui, cui->waitset, false);
856 /* Loop here for scripts that just started the server. */
859 for (i = start_deamon ? 2 : 10; i; i--) {
860 cui->client = discover_client_init(cui->waitset,
861 &cui_client_ops, cui);
862 if (cui->client || !i)
864 pb_log("%s: waiting for server %d\n", __func__, i);
868 if (!cui->client && start_deamon) {
873 result = pb_start_daemon(cui);
878 pb_log("%s: discover_client_init failed.\n", __func__);
879 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
881 fprintf(stderr, _("could not start pb-discover, the petitboot "
883 goto fail_client_init;
887 pb_log("%s: discover_client_init failed.\n", __func__);
888 fprintf(stderr, _("%s: error: discover_client_init failed.\n"),
890 fprintf(stderr, _("check that pb-discover, "
891 "the petitboot daemon is running.\n"));
892 goto fail_client_init;
896 talloc_steal(cui, cui->client);
899 cui->main = main_menu_init(cui);
901 goto fail_client_init;
903 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
904 cui_process_key, cui);
908 cui->pjs = pjs_init(cui, js_map);
911 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
912 WAIT_IN, cui_process_js, cui);
924 * cui_run - The main cui program loop.
925 * @cui: The cui instance.
926 * @main: The menu to use as the main menu.
928 * Runs the cui engine. Does not return until indicated to do so by some
929 * user action, or an error occurs. Frees the cui object on return.
930 * Returns 0 on success (return to shell), -1 on error (should restart).
933 int cui_run(struct cui *cui)
937 cui->current = &cui->main->scr;
938 cui->default_item = 0;
940 nc_scr_post(cui->current);
943 int result = waiter_poll(cui->waitset);
946 pb_log("%s: poll: %s\n", __func__, strerror(errno));
953 while (cui->resize) {
955 cui_handle_resize(cui);
961 return cui->abort ? 0 : -1;