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 while (getch() != ERR) /* flush stdin */
65 static void cui_atexit(void)
73 * cui_abort - Signal the main cui program loop to exit.
75 * Sets cui.abort, which causes the cui_run() routine to return.
78 void cui_abort(struct cui *cui)
80 pb_log("%s: exiting\n", __func__);
85 * cui_resize - Signal the main cui program loop to resize
90 void cui_resize(struct cui *cui)
92 pb_debug("%s: resizing\n", __func__);
97 * cui_on_exit - A generic main menu exit callback.
100 void cui_on_exit(struct pmenu *menu)
102 cui_abort(cui_from_pmenu(menu));
106 * cui_run_cmd - A generic cb to run the supplied command.
109 int cui_run_cmd(struct pmenu_item *item)
112 struct cui *cui = cui_from_item(item);
113 const char **cmd_argv = item->data;
115 nc_scr_status_printf(cui->current, "Running %s...", cmd_argv[0]);
119 result = process_run_simple_argv(item, cmd_argv);
122 redrawwin(cui->current->main_ncw);
125 pb_log("%s: failed: '%s'\n", __func__, cmd_argv[0]);
126 nc_scr_status_printf(cui->current, "Failed: %s", cmd_argv[0]);
133 * cui_boot - A generic cb to run kexec.
136 static int cui_boot(struct pmenu_item *item)
139 struct cui *cui = cui_from_item(item);
140 struct cui_opt_data *cod = cod_from_item(item);
142 assert(cui->current == &cui->main->scr);
144 pb_debug("%s: %s\n", __func__, cod->name);
146 nc_scr_status_printf(cui->current, "Booting %s...", cod->name);
148 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
151 nc_scr_status_printf(cui->current,
152 "Failed: boot %s", cod->bd->image);
158 static void cui_boot_editor_on_exit(struct cui *cui,
159 struct pmenu_item *item,
160 struct pb_boot_data *bd)
162 struct pmenu *menu = cui->main;
163 struct cui_opt_data *cod;
164 static int user_idx = 0;
166 /* Was the edit cancelled? */
168 cui_set_current(cui, &cui->main->scr);
169 talloc_free(cui->boot_editor);
170 cui->boot_editor = NULL;
174 /* Is this was a new item, we'll need to update the menu */
178 cod = talloc_zero(NULL, struct cui_opt_data);
179 cod->name = talloc_asprintf(cod, "User item %u", ++user_idx);
181 item = pmenu_item_create(menu, cod->name);
187 item->on_edit = cui_item_edit;
188 item->on_execute = cui_boot;
191 talloc_steal(item, cod);
193 /* Detach the items array. */
194 set_menu_items(menu->ncm, NULL);
196 /* Insert new item at insert_pt. */
197 insert_pt = pmenu_grow(menu, 1);
198 pmenu_item_insert(menu, item, insert_pt);
200 /* Re-attach the items array. */
201 set_menu_items(menu->ncm, menu->items);
202 nc_scr_post(&menu->scr);
207 cod->bd = talloc_steal(cod, bd);
209 set_current_item(item->pmenu->ncm, item->nci);
211 cui_set_current(cui, &cui->main->scr);
212 talloc_free(cui->boot_editor);
213 cui->boot_editor = NULL;
216 void cui_item_edit(struct pmenu_item *item)
218 struct cui *cui = cui_from_item(item);
219 cui->boot_editor = boot_editor_init(cui, item, cui->sysinfo,
220 cui_boot_editor_on_exit);
221 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
224 void cui_item_new(struct pmenu *menu)
226 struct cui *cui = cui_from_pmenu(menu);
227 cui->boot_editor = boot_editor_init(cui, NULL, cui->sysinfo,
228 cui_boot_editor_on_exit);
229 cui_set_current(cui, boot_editor_scr(cui->boot_editor));
232 static void cui_sysinfo_exit(struct cui *cui)
234 cui_set_current(cui, &cui->main->scr);
235 talloc_free(cui->sysinfo_screen);
236 cui->sysinfo_screen = NULL;
239 void cui_show_sysinfo(struct cui *cui)
241 cui->sysinfo_screen = sysinfo_screen_init(cui, cui->sysinfo,
243 cui_set_current(cui, sysinfo_screen_scr(cui->sysinfo_screen));
246 static void cui_config_exit(struct cui *cui)
248 cui_set_current(cui, &cui->main->scr);
249 talloc_free(cui->config_screen);
250 cui->config_screen = NULL;
253 void cui_show_config(struct cui *cui)
255 cui->config_screen = config_screen_init(cui, cui->config,
256 cui->sysinfo, cui_config_exit);
257 cui_set_current(cui, config_screen_scr(cui->config_screen));
260 static void cui_help_exit(struct cui *cui)
262 cui_set_current(cui, help_screen_return_scr(cui->help_screen));
263 talloc_free(cui->help_screen);
264 cui->help_screen = NULL;
267 void cui_show_help(struct cui *cui, const char *title, const char *text)
272 if (cui->help_screen)
275 cui->help_screen = help_screen_init(cui, cui->current,
276 title, text, cui_help_exit);
278 if (cui->help_screen)
279 cui_set_current(cui, help_screen_scr(cui->help_screen));
283 * cui_set_current - Set the currently active screen and redraw it.
286 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
290 DBGS("%p -> %p\n", cui->current, scr);
292 assert(cui->current != scr);
299 nc_scr_post(cui->current);
304 static bool process_global_keys(struct cui *cui, int key)
308 if (cui->current && cui->current->main_ncw)
316 * cui_process_key - Process input on stdin.
319 static int cui_process_key(void *arg)
321 struct cui *cui = cui_from_arg(arg);
323 assert(cui->current);
326 discover_client_cancel_default(cui->client);
327 cui->has_input = true;
332 pb_debug("%s: got key %d\n", __func__, c);
337 if (process_global_keys(cui, c))
340 cui->current->process_key(cui->current, c);
347 * cui_process_js - Process joystick events.
350 static int cui_process_js(void *arg)
352 struct cui *cui = cui_from_arg(arg);
355 c = pjs_process_event(cui->pjs);
359 cui_process_key(arg);
366 * cui_handle_resize - Handle the term resize.
369 static void cui_handle_resize(struct cui *cui)
373 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
374 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
378 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
380 wclear(cui->current->main_ncw);
381 resize_term(ws.ws_row, ws.ws_col);
382 cui->current->resize(cui->current);
384 /* For some reason this makes ncurses redraw the screen */
386 redrawwin(cui->current->main_ncw);
387 wrefresh(cui->current->main_ncw);
391 * cui_device_add - Client device_add callback.
393 * Creates menu_items for all the device boot_options and inserts those
394 * menu_items into the main menu. Redraws the main menu if it is active.
397 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
400 struct cui *cui = cui_from_arg(arg);
401 struct cui_opt_data *cod;
402 unsigned int insert_pt;
403 int result, rows, cols;
404 struct pmenu_item *i;
407 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
409 selected = current_item(cui->main->ncm);
410 menu_format(cui->main->ncm, &rows, &cols);
412 if (cui->current == &cui->main->scr)
413 nc_scr_unpost(cui->current);
415 /* Save the item in opt->ui_info for cui_device_remove() */
417 opt->ui_info = i = pmenu_item_create(cui->main, opt->name);
421 i->on_edit = cui_item_edit;
422 i->on_execute = cui_boot;
423 i->data = cod = talloc(i, struct cui_opt_data);
427 cod->opt_hash = pb_opt_hash(dev, opt);
428 cod->name = opt->name;
429 cod->bd = talloc(i, struct pb_boot_data);
431 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
432 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
433 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
434 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
436 /* This disconnects items array from menu. */
437 result = set_menu_items(cui->main->ncm, NULL);
440 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
442 /* Insert new items at insert_pt. */
443 insert_pt = pmenu_grow(cui->main, 1);
444 pmenu_item_insert(cui->main, i, insert_pt);
446 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
447 pb_log(" image '%s'\n", cod->bd->image);
448 pb_log(" initrd '%s'\n", cod->bd->initrd);
449 pb_log(" args '%s'\n", cod->bd->args);
451 /* Re-attach the items array. */
452 result = set_menu_items(cui->main->ncm, cui->main->items);
455 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
458 pb_log("%s\n", __func__);
459 pmenu_dump_items(cui->main->items,
460 item_count(cui->main->ncm) + 1);
463 if (!item_visible(selected)) {
466 top = top_row(cui->main->ncm);
467 idx = item_index(selected);
469 /* If our index is above the current top row, align
470 * us to the new top. Otherwise, align us to the new
472 top = top < idx ? idx - rows : idx;
474 set_top_row(cui->main->ncm, top);
475 set_current_item(cui->main->ncm, selected);
478 if (cui->current == &cui->main->scr)
479 nc_scr_post(cui->current);
485 * cui_device_remove - Client device remove callback.
487 * Removes all the menu_items for the device from the main menu and redraws the
488 * main menu if it is active.
491 static void cui_device_remove(struct device *dev, void *arg)
493 struct cui *cui = cui_from_arg(arg);
495 struct boot_option *opt;
497 pb_log("%s: %p %s\n", __func__, dev, dev->id);
499 if (cui->current == &cui->main->scr)
500 nc_scr_unpost(cui->current);
502 /* This disconnects items array from menu. */
504 result = set_menu_items(cui->main->ncm, NULL);
507 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
509 list_for_each_entry(&dev->boot_options, opt, list) {
510 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
512 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
513 pmenu_remove(cui->main, i);
516 /* Re-attach the items array. */
518 result = set_menu_items(cui->main->ncm, cui->main->items);
521 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
524 pb_log("%s\n", __func__);
525 pmenu_dump_items(cui->main->items,
526 item_count(cui->main->ncm) + 1);
529 if (cui->current == &cui->main->scr)
530 nc_scr_post(cui->current);
533 static void cui_update_status(struct boot_status *status, void *arg)
535 struct cui *cui = cui_from_arg(arg);
537 nc_scr_status_printf(cui->current,
539 status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
544 static void cui_update_mm_title(struct cui *cui)
546 struct nc_frame *frame = &cui->main->scr.frame;
548 talloc_free(frame->rtitle);
550 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
551 if (cui->sysinfo->identifier)
552 frame->rtitle = talloc_asprintf_append(frame->rtitle,
553 " %s", cui->sysinfo->identifier);
555 if (cui->current == &cui->main->scr)
556 nc_scr_post(cui->current);
559 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
561 struct cui *cui = cui_from_arg(arg);
562 cui->sysinfo = talloc_steal(cui, sysinfo);
564 /* if we're currently displaying the system info screen, inform it
565 * of the updated information. */
566 if (cui->sysinfo_screen)
567 sysinfo_screen_update(cui->sysinfo_screen, sysinfo);
569 /* ... and do the same with the config screen... */
570 if (cui->config_screen)
571 config_screen_update(cui->config_screen, cui->config, sysinfo);
573 /* ... and the boot editor. */
574 if (cui->boot_editor)
575 boot_editor_update(cui->boot_editor, sysinfo);
577 cui_update_mm_title(cui);
580 static void cui_update_config(struct config *config, void *arg)
582 struct cui *cui = cui_from_arg(arg);
583 cui->config = talloc_steal(cui, config);
585 if (cui->config_screen)
586 config_screen_update(cui->config_screen, config, cui->sysinfo);
589 int cui_send_config(struct cui *cui, struct config *config)
591 return discover_client_send_config(cui->client, config);
594 void cui_send_reinit(struct cui *cui)
596 discover_client_send_reinit(cui->client);
599 static struct discover_client_ops cui_client_ops = {
601 .boot_option_add = cui_boot_option_add,
602 .device_remove = cui_device_remove,
603 .update_status = cui_update_status,
604 .update_sysinfo = cui_update_sysinfo,
605 .update_config = cui_update_config,
609 * cui_init - Setup the cui instance.
610 * @platform_info: A value for the struct cui platform_info member.
612 * Returns a pointer to a struct cui on success, or NULL on error.
614 * Allocates the cui instance, sets up the client and stdin waiters, and
615 * sets up the ncurses menu screen.
618 struct cui *cui_init(void* platform_info,
619 int (*js_map)(const struct js_event *e), int start_deamon)
624 cui = talloc_zero(NULL, struct cui);
627 pb_log("%s: alloc cui failed.\n", __func__);
628 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
632 cui->c_sig = pb_cui_sig;
633 cui->platform_info = platform_info;
634 cui->waitset = waitset_create(cui);
636 process_init(cui, cui->waitset, false);
638 setlocale(LC_ALL, "");
640 /* Loop here for scripts that just started the server. */
643 for (i = start_deamon ? 2 : 10; i; i--) {
644 cui->client = discover_client_init(cui->waitset,
645 &cui_client_ops, cui);
646 if (cui->client || !i)
648 pb_log("%s: waiting for server %d\n", __func__, i);
652 if (!cui->client && start_deamon) {
657 result = pb_start_daemon(cui);
662 pb_log("%s: discover_client_init failed.\n", __func__);
663 fprintf(stderr, "%s: error: discover_client_init failed.\n",
665 fprintf(stderr, "could not start pb-discover, the petitboot "
667 goto fail_client_init;
671 pb_log("%s: discover_client_init failed.\n", __func__);
672 fprintf(stderr, "%s: error: discover_client_init failed.\n",
674 fprintf(stderr, "check that pb-discover, "
675 "the petitboot daemon is running.\n");
676 goto fail_client_init;
682 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
683 cui_process_key, cui);
687 cui->pjs = pjs_init(cui, js_map);
690 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
691 WAIT_IN, cui_process_js, cui);
703 * cui_run - The main cui program loop.
704 * @cui: The cui instance.
705 * @main: The menu to use as the main menu.
707 * Runs the cui engine. Does not return until indicated to do so by some
708 * user action, or an error occurs. Frees the cui object on return.
709 * Returns 0 on success (return to shell), -1 on error (should restart).
712 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
717 cui->current = &cui->main->scr;
718 cui->default_item = default_item;
720 nc_scr_post(cui->current);
723 int result = waiter_poll(cui->waitset);
726 pb_log("%s: poll: %s\n", __func__, strerror(errno));
733 while (cui->resize) {
735 cui_handle_resize(cui);
741 return cui->abort ? 0 : -1;