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
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"
38 static struct cui_opt_data *cod_from_item(struct pmenu_item *item)
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);
150 result = discover_client_boot(cui->client, NULL, cod->opt, cod->bd);
153 redrawwin(cui->current->main_ncw);
156 nc_scr_status_printf(cui->current,
157 "Failed: boot %s", cod->bd->image);
164 * cui_boot_editor_on_exit - The boot_editor on_exit callback.
167 static void cui_boot_editor_on_exit(struct boot_editor *boot_editor,
168 enum boot_editor_result boot_editor_result,
169 struct pb_boot_data *bd)
171 struct cui *cui = cui_from_pmenu(boot_editor->original_pmenu);
172 struct pmenu_item *item = boot_editor->data;
173 struct cui_opt_data *cod;
175 if (boot_editor_result != boot_editor_update) {
176 cui_set_current(cui, &cui->main->scr);
177 talloc_free(boot_editor);
183 /* Is this was a new item, we'll need to update the menu */
185 struct pmenu *menu = boot_editor->original_pmenu;
188 /* Detach the items array. */
189 set_menu_items(menu->ncm, NULL);
191 /* Insert new item at insert_pt. */
192 insert_pt = pmenu_grow(menu, 1);
193 item = pmenu_item_alloc(menu);
194 item->on_edit = cui_item_edit;
195 item->on_execute = cui_boot;
196 item->data = cod = talloc_zero(item, struct cui_opt_data);
198 cod->name = talloc_asprintf(cod, "User item %u:", insert_pt);
199 pmenu_item_setup(menu, item, insert_pt,
200 talloc_strdup(item, cod->name));
202 /* Re-attach the items array. */
203 set_menu_items(menu->ncm, menu->items);
204 nc_scr_post(&menu->scr);
209 cod->bd = talloc_steal(cod, bd);
211 /* FIXME: need to make item visible somehow */
212 set_current_item(item->pmenu->ncm, item->nci);
213 cui_set_current(cui, &cui->main->scr);
214 talloc_free(boot_editor);
217 void cui_item_edit(struct pmenu_item *item)
219 struct cui *cui = cui_from_item(item);
220 struct cui_opt_data *cod = cod_from_item(item);
221 struct boot_editor *boot_editor;
223 boot_editor = boot_editor_init(item->pmenu, cod->bd,
224 cui_boot_editor_on_exit);
225 boot_editor->data = item;
226 cui_set_current(cui, &boot_editor->scr);
229 void cui_item_new(struct pmenu *menu)
231 struct cui *cui = cui_from_pmenu(menu);
232 struct boot_editor *boot_editor;
234 boot_editor = boot_editor_init(menu, NULL,
235 cui_boot_editor_on_exit);
236 cui_set_current(cui, &boot_editor->scr);
240 * cui_set_current - Set the currently active screen and redraw it.
243 struct nc_scr *cui_set_current(struct cui *cui, struct nc_scr *scr)
247 DBGS("%p -> %p\n", cui->current, scr);
249 assert(cui->current != scr);
256 nc_scr_post(cui->current);
261 static bool process_global_keys(struct cui *cui, int key)
265 if (cui->current && cui->current->main_ncw) {
266 redrawwin(cui->current->main_ncw);
267 wrefresh(cui->current->main_ncw);
275 * cui_process_key - Process input on stdin.
278 static int cui_process_key(void *arg)
280 struct cui *cui = cui_from_arg(arg);
282 assert(cui->current);
285 discover_client_cancel_default(cui->client);
286 cui->has_input = true;
294 if (process_global_keys(cui, c))
297 cui->current->process_key(cui->current, c);
304 * cui_process_js - Process joystick events.
307 static int cui_process_js(void *arg)
309 struct cui *cui = cui_from_arg(arg);
312 c = pjs_process_event(cui->pjs);
316 cui_process_key(arg);
323 * cui_handle_resize - Handle the term resize.
326 static void cui_handle_resize(struct cui *cui)
330 if (ioctl(1, TIOCGWINSZ, &ws) == -1) {
331 pb_log("%s: ioctl failed: %s\n", __func__, strerror(errno));
335 pb_debug("%s: {%u,%u}\n", __func__, ws.ws_row, ws.ws_col);
337 wclear(cui->current->main_ncw);
338 resize_term(ws.ws_row, ws.ws_col);
339 cui->current->resize(cui->current);
341 /* For some reason this makes ncurses redraw the screen */
343 redrawwin(cui->current->main_ncw);
344 wrefresh(cui->current->main_ncw);
348 * cui_device_add - Client device_add callback.
350 * Creates menu_items for all the device boot_options and inserts those
351 * menu_items into the main menu. Redraws the main menu if it is active.
354 static int cui_boot_option_add(struct device *dev, struct boot_option *opt,
357 struct cui *cui = cui_from_arg(arg);
358 struct cui_opt_data *cod;
359 unsigned int insert_pt;
360 struct pmenu_item *i;
364 pb_debug("%s: %p %s\n", __func__, opt, opt->id);
366 selected = current_item(cui->main->ncm);
368 if (cui->current == &cui->main->scr)
369 nc_scr_unpost(cui->current);
371 /* This disconnects items array from menu. */
373 result = set_menu_items(cui->main->ncm, NULL);
376 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
378 /* Insert new items at insert_pt. */
379 insert_pt = pmenu_grow(cui->main, 1);
381 /* Save the item in opt->ui_info for cui_device_remove() */
383 opt->ui_info = i = pmenu_item_alloc(cui->main);
385 i->on_edit = cui_item_edit;
386 i->on_execute = cui_boot;
387 i->data = cod = talloc(i, struct cui_opt_data);
391 cod->opt_hash = pb_opt_hash(dev, opt);
392 cod->name = opt->name;
393 cod->bd = talloc(i, struct pb_boot_data);
395 cod->bd->image = talloc_strdup(cod->bd, opt->boot_image_file);
396 cod->bd->initrd = talloc_strdup(cod->bd, opt->initrd_file);
397 cod->bd->dtb = talloc_strdup(cod->bd, opt->dtb_file);
398 cod->bd->args = talloc_strdup(cod->bd, opt->boot_args);
400 pmenu_item_setup(cui->main, i, insert_pt, cod->name);
402 pb_log("%s: adding opt '%s'\n", __func__, cod->name);
403 pb_log(" image '%s'\n", cod->bd->image);
404 pb_log(" initrd '%s'\n", cod->bd->initrd);
405 pb_log(" args '%s'\n", cod->bd->args);
407 /* Re-attach the items array. */
408 result = set_menu_items(cui->main->ncm, cui->main->items);
411 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
414 pb_log("%s\n", __func__);
415 pmenu_dump_items(cui->main->items,
416 item_count(cui->main->ncm) + 1);
419 /* FIXME: need to make item visible somehow */
420 menu_driver(cui->main->ncm, REQ_SCR_UPAGE);
421 menu_driver(cui->main->ncm, REQ_SCR_DPAGE);
422 set_current_item(cui->main->ncm, selected);
424 if (cui->current == &cui->main->scr)
425 nc_scr_post(cui->current);
431 * cui_device_remove - Client device remove callback.
433 * Removes all the menu_items for the device from the main menu and redraws the
434 * main menu if it is active.
437 static void cui_device_remove(struct device *dev, void *arg)
439 struct cui *cui = cui_from_arg(arg);
441 struct boot_option *opt;
443 pb_log("%s: %p %s\n", __func__, dev, dev->id);
445 if (cui->current == &cui->main->scr)
446 nc_scr_unpost(cui->current);
448 /* This disconnects items array from menu. */
450 result = set_menu_items(cui->main->ncm, NULL);
453 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
455 list_for_each_entry(&dev->boot_options, opt, list) {
456 struct pmenu_item *i = pmenu_item_from_arg(opt->ui_info);
458 assert(pb_protocol_device_cmp(dev, cod_from_item(i)->dev));
459 pmenu_remove(cui->main, i);
462 /* Re-attach the items array. */
464 result = set_menu_items(cui->main->ncm, cui->main->items);
467 pb_log("%s: set_menu_items failed: %d\n", __func__, result);
470 pb_log("%s\n", __func__);
471 pmenu_dump_items(cui->main->items,
472 item_count(cui->main->ncm) + 1);
475 if (cui->current == &cui->main->scr)
476 nc_scr_post(cui->current);
479 static void cui_update_status(struct boot_status *status, void *arg)
481 struct cui *cui = cui_from_arg(arg);
483 nc_scr_status_printf(cui->current,
485 status->type == BOOT_STATUS_ERROR ? "Error" : "Info",
490 static void cui_update_mm_title(struct cui *cui)
492 struct nc_frame *frame = &cui->main->scr.frame;
494 talloc_free(frame->rtitle);
496 frame->rtitle = talloc_strdup(cui->main, cui->sysinfo->type);
497 if (cui->sysinfo->identifier)
498 frame->rtitle = talloc_asprintf_append(frame->rtitle,
499 " %s", cui->sysinfo->identifier);
501 if (cui->current == &cui->main->scr)
502 nc_scr_post(cui->current);
505 static void cui_update_sysinfo(struct system_info *sysinfo, void *arg)
507 struct cui *cui = cui_from_arg(arg);
508 cui->sysinfo = talloc_steal(cui, sysinfo);
509 cui_update_mm_title(cui);
512 static struct discover_client_ops cui_client_ops = {
514 .boot_option_add = cui_boot_option_add,
515 .device_remove = cui_device_remove,
516 .update_status = cui_update_status,
517 .update_sysinfo = cui_update_sysinfo,
521 * cui_init - Setup the cui instance.
522 * @platform_info: A value for the struct cui platform_info member.
524 * Returns a pointer to a struct cui on success, or NULL on error.
526 * Allocates the cui instance, sets up the client and stdin waiters, and
527 * sets up the ncurses menu screen.
530 struct cui *cui_init(void* platform_info,
531 int (*js_map)(const struct js_event *e), int start_deamon)
536 cui = talloc_zero(NULL, struct cui);
539 pb_log("%s: alloc cui failed.\n", __func__);
540 fprintf(stderr, "%s: alloc cui failed.\n", __func__);
544 cui->c_sig = pb_cui_sig;
545 cui->platform_info = platform_info;
546 cui->waitset = waitset_create(cui);
548 process_init(cui, cui->waitset, false);
550 setlocale(LC_ALL, "");
552 /* Loop here for scripts that just started the server. */
555 for (i = start_deamon ? 2 : 10; i; i--) {
556 cui->client = discover_client_init(cui->waitset,
557 &cui_client_ops, cui);
558 if (cui->client || !i)
560 pb_log("%s: waiting for server %d\n", __func__, i);
564 if (!cui->client && start_deamon) {
569 result = pb_start_daemon(cui);
574 pb_log("%s: discover_client_init failed.\n", __func__);
575 fprintf(stderr, "%s: error: discover_client_init failed.\n",
577 fprintf(stderr, "could not start pb-discover, the petitboot "
579 goto fail_client_init;
583 pb_log("%s: discover_client_init failed.\n", __func__);
584 fprintf(stderr, "%s: error: discover_client_init failed.\n",
586 fprintf(stderr, "check that pb-discover, "
587 "the petitboot daemon is running.\n");
588 goto fail_client_init;
594 waiter_register_io(cui->waitset, STDIN_FILENO, WAIT_IN,
595 cui_process_key, cui);
599 cui->pjs = pjs_init(cui, js_map);
602 waiter_register_io(cui->waitset, pjs_get_fd(cui->pjs),
603 WAIT_IN, cui_process_js, cui);
615 * cui_run - The main cui program loop.
616 * @cui: The cui instance.
617 * @main: The menu to use as the main menu.
619 * Runs the cui engine. Does not return until indicated to do so by some
620 * user action, or an error occurs. Frees the cui object on return.
621 * Returns 0 on success (return to shell), -1 on error (should restart).
624 int cui_run(struct cui *cui, struct pmenu *main, unsigned int default_item)
629 cui->current = &cui->main->scr;
630 cui->default_item = default_item;
632 nc_scr_post(cui->current);
635 int result = waiter_poll(cui->waitset);
638 pb_log("%s: poll: %s\n", __func__, strerror(errno));
645 while (cui->resize) {
647 cui_handle_resize(cui);
653 return cui->abort ? 0 : -1;