Remove nc menu description
[petitboot] / ui / ncurses / ps3-cui.c
1 /*
2  * Petitboot cui bootloader for the PS3 game console
3  *
4  *  Copyright (C) 2009 Sony Computer Entertainment Inc.
5  *  Copyright 2009 Sony Corp.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; version 2 of the License.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 /*
22  * TODO
23  * removable media event
24  * ncurses mouse support
25  */
26
27 #if defined(HAVE_CONFIG_H)
28 #include "config.h"
29 #endif
30
31 #define _GNU_SOURCE
32 #include <errno.h>
33 #include <getopt.h>
34 #include <signal.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sys/time.h>
38
39 #include "log/log.h"
40 #include "talloc/talloc.h"
41 #include "waiter/waiter.h"
42 #include "ui/common/discover-client.h"
43 #include "ui/common/ps3.h"
44 #include "nc-cui.h"
45
46 static void print_version(void)
47 {
48         printf("pb-cui (" PACKAGE_NAME ") " PACKAGE_VERSION "\n");
49 }
50
51 static void print_usage(void)
52 {
53         print_version();
54         printf(
55 "Usage: pb-cui [-h, --help] [-l, --log log-file] [-r, --reset-defaults]\n"
56 "              [-t, --timeout] [-V, --version]\n");
57 }
58
59 /**
60  * enum opt_value - Tri-state options variables.
61  */
62
63 enum opt_value {opt_undef = 0, opt_yes, opt_no};
64
65 /**
66  * struct opts - Values from command line options.
67  */
68
69 struct opts {
70         enum opt_value show_help;
71         const char *log_file;
72         enum opt_value reset_defaults;
73         enum opt_value use_timeout;
74         enum opt_value show_version;
75 };
76
77 /**
78  * opts_parse - Parse the command line options.
79  */
80
81 static int opts_parse(struct opts *opts, int argc, char *argv[])
82 {
83         static const struct option long_options[] = {
84                 {"help",           no_argument,       NULL, 'h'},
85                 {"log",            required_argument, NULL, 'l'},
86                 {"reset-defaults", no_argument,       NULL, 'r'},
87                 {"timeout",        no_argument,       NULL, 't'},
88                 {"version",        no_argument,       NULL, 'V'},
89                 { NULL, 0, NULL, 0},
90         };
91         static const char short_options[] = "hl:trV";
92         static const struct opts default_values = {
93                 .log_file = "pb-cui.log",
94         };
95
96         *opts = default_values;
97
98         while (1) {
99                 int c = getopt_long(argc, argv, short_options, long_options,
100                         NULL);
101
102                 if (c == EOF)
103                         break;
104
105                 switch (c) {
106                 case 'h':
107                         opts->show_help = opt_yes;
108                         break;
109                 case 'l':
110                         opts->log_file = optarg;
111                         break;
112                 case 't':
113                         opts->use_timeout = opt_yes;
114                         break;
115                 case 'r':
116                         opts->reset_defaults = opt_yes;
117                         break;
118                 case 'V':
119                         opts->show_version = opt_yes;
120                         break;
121                 default:
122                         opts->show_help = opt_yes;
123                         return -1;
124                 }
125         }
126
127         return optind != argc;
128 }
129
130 /**
131  * struct ps3_cui - Main cui program instance.
132  * @mm: Main menu.
133  * @svm: Set video mode menu.
134  */
135
136 struct ps3_cui {
137         struct pmenu *mm;
138         struct pmenu *svm;
139         struct cui *cui;
140         struct ps3_flash_values values;
141         int dirty_values;
142 };
143
144 static struct ps3_cui *ps3_from_cui(struct cui *cui)
145 {
146         struct ps3_cui *ps3;
147
148         assert(cui->c_sig == pb_cui_sig);
149         ps3 = cui->platform_info;
150         assert(ps3->cui->c_sig == pb_cui_sig);
151         return ps3;
152 }
153
154 static struct ps3_cui *ps3_from_item(struct pmenu_item *item)
155 {
156         return ps3_from_cui(cui_from_item(item));
157 }
158
159 /**
160  * ps3_set_mode - Set video mode helper.
161  *
162  * Runs ps3_set_video_mode().
163  */
164
165 static void ps3_set_mode(struct ps3_cui *ps3, unsigned int mode)
166 {
167         int result;
168
169         if (ps3->values.video_mode == (uint16_t)mode)
170                 return;
171
172         ps3->values.video_mode = (uint16_t)mode;
173         ps3->dirty_values = 1;
174
175         result = ps3_set_video_mode(mode);
176
177         if (result)
178                 nc_scr_status_printf(ps3->cui->current,
179                         "Failed: set_video_mode(%u)", mode);
180 }
181
182 /**
183  * ps3_svm_cb - The set video mode callback.
184  */
185
186 static int ps3_svm_cb(struct pmenu_item *item)
187 {
188         ps3_set_mode(ps3_from_item(item), (unsigned int)item->data);
189         return 0;
190 }
191
192 /**
193  * ps3_kexec_cb - The kexec callback.
194  *
195  * Writes config data to PS3 flash then calls pb_run_kexec().
196  */
197
198 static int ps3_kexec_cb(struct cui *cui, struct cui_opt_data *cod)
199 {
200         struct ps3_cui *ps3 = ps3_from_cui(cui);
201
202         pb_log("%s: %s\n", __func__, cod->name);
203
204         assert(ps3->cui->current == &ps3->cui->main->scr);
205
206         if ((cod->opt_hash && cod->opt_hash != cui->default_item)
207                 || ps3->dirty_values) {
208                 ps3->values.default_item = cod->opt_hash;
209                 ps3_flash_set_values(&ps3->values);
210         }
211
212         return pb_run_kexec(cod->kd);
213 }
214
215 /**
216  * ps3_mm_to_svm_cb - Callback to switch to the set video mode menu.
217  */
218
219 static int ps3_mm_to_svm_cb(struct pmenu_item *item)
220 {
221         struct ps3_cui *ps3 = ps3_from_item(item);
222         struct nc_scr *old;
223
224         old = cui_set_current(ps3->cui, &ps3->svm->scr);
225         assert(old == &ps3->mm->scr);
226
227         return 0;
228 }
229
230 /**
231  * ps3_svm_to_mm_cb - Callback to switch back to the main menu.
232  */
233
234 static int ps3_svm_to_mm_cb(struct pmenu_item *item)
235 {
236         struct ps3_cui *ps3 = ps3_from_item(item);
237         struct nc_scr *old;
238
239         old = cui_set_current(ps3->cui, &ps3->mm->scr);
240         assert(old == &ps3->svm->scr);
241
242         return 0;
243 }
244
245 /**
246  * ps3_svm_to_mm_helper - The svm ESC callback.
247  */
248
249 static void ps3_svm_to_mm_helper(struct pmenu *menu)
250 {
251         ps3_svm_to_mm_cb(pmenu_find_selected(menu));
252 }
253
254 /**
255  * ps3_hot_key - PS3 specific hot keys.
256  *
257  * '@' = Set video mode to auto (mode 0)
258  * '$' = Set video mode to safe (480i)
259  * '+' = Cycles through a set of common video modes.
260  * '-' = Cycles through a set of common video modes in reverse.
261  */
262
263 static int ps3_hot_key(struct pmenu __attribute__((unused)) *menu,
264         struct pmenu_item *item, int c)
265 {
266         static const unsigned int modes[] = {0, 1, 6, 3, 11, 12};
267         static const unsigned int *const end = modes
268                 + sizeof(modes) / sizeof(modes[0]) - 1;
269         static const unsigned int *p = modes;
270
271         switch (c) {
272         default:
273                 /* DBGS("%d (%o)\n", c, c); */
274                 break;
275         case '@':
276                 p = modes + 0;
277                 ps3_set_mode(ps3_from_item(item), *p);
278                 break;
279         case '$':
280                 p = modes + 1;
281                 ps3_set_mode(ps3_from_item(item), *p);
282                 break;
283         case '+':
284                 p = (p < end) ? p + 1 : modes;
285                 ps3_set_mode(ps3_from_item(item), *p);
286                 break;
287         case '-':
288                 p = (p > modes) ? p - 1 : end;
289                 ps3_set_mode(ps3_from_item(item), *p);
290                 break;
291         }
292
293         return c;
294 }
295
296 /**
297  * ps3_timer_update - Timer callback.
298  */
299
300 static void ps3_timer_update(struct ui_timer *timer, unsigned int timeout)
301 {
302         struct ps3_cui *ps3 = ps3_from_cui(cui_from_timer(timer));
303
304         //FIXME: make scr:timer.
305         // nc_scr_timer_update(&ps3.mm->scr, timeout);
306
307         nc_scr_status_printf(&ps3->mm->scr,
308                 "Welcome to Petitboot (timeout %u sec)", timeout);
309 }
310
311 /**
312  * ps3_mm_init - Setup the main menu instance.
313  */
314
315 static struct pmenu *ps3_mm_init(struct ps3_cui *ps3_cui)
316 {
317         int result;
318         struct pmenu *m;
319         struct pmenu_item *i;
320         static const char *const bgo[] = {"/usr/sbin/ps3-boot-game-os", NULL};
321
322         m = pmenu_init(ps3_cui->cui, 3, cui_on_exit);
323
324         if (!m) {
325                 pb_log("%s: failed\n", __func__);
326                 return NULL;
327         }
328
329         m->hot_key = ps3_hot_key;
330         m->on_open = cui_on_open;
331
332 #if defined(DEBUG)
333         m->scr.frame.title = talloc_strdup(m,
334                 "Petitboot PS3 (ver " PACKAGE_VERSION ")");
335 #else
336         m->scr.frame.title = talloc_strdup(m, "Petitboot PS3");
337 #endif
338         m->scr.frame.help = talloc_strdup(m,
339                 "ESC=exit, Enter=accept, e=edit, o=open");
340         m->scr.frame.status = talloc_strdup(m, "Welcome to Petitboot");
341
342         i = pmenu_item_init(m, 0, "Boot GameOS");
343         i->on_execute = cui_run_cmd;
344         i->data = (void *)bgo;
345
346         i = pmenu_item_init(m, 1, "Set Video Mode");
347         i->on_execute = ps3_mm_to_svm_cb;
348
349         i = pmenu_item_init(m, 2, "Exit to Shell");
350         i->on_execute = pmenu_exit_cb;
351
352         result = pmenu_setup(m);
353
354         if (result) {
355                 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
356                         strerror(errno));
357                 goto fail_setup;
358         }
359
360         menu_opts_off(m->ncm, O_SHOWDESC);
361         set_menu_mark(m->ncm, " *");
362         set_current_item(m->ncm, i->nci);
363
364         return m;
365
366 fail_setup:
367         talloc_free(m);
368         return NULL;
369 }
370
371 /**
372  * ps3_svm_init - Setup the set video mode menu instance.
373  */
374
375 static struct pmenu *ps3_svm_init(struct ps3_cui *ps3_cui)
376 {
377         int result;
378         struct pmenu *m;
379         struct pmenu_item *i;
380
381         m = pmenu_init(ps3_cui->cui, 12, ps3_svm_to_mm_helper);
382
383         if (!m) {
384                 pb_log("%s: failed\n", __func__);
385                 return NULL;
386         }
387
388         m->hot_key = ps3_hot_key;
389         m->scr.frame.title = talloc_strdup(m, "Select PS3 Video Mode");
390         m->scr.frame.help = talloc_strdup(m, "ESC=exit, Enter=accept");
391
392         i = pmenu_item_init(m, 0, "auto detect");
393         i->on_execute = ps3_svm_cb;
394         i->data = (void *)0;
395
396         i = pmenu_item_init(m, 1, "480i    (576 x 384)");
397         i->on_execute = ps3_svm_cb;
398         i->data = (void *)1;
399
400         i = pmenu_item_init(m, 2, "480p    (576 x 384)");
401         i->on_execute = ps3_svm_cb;
402         i->data = (void *)2;
403
404         i = pmenu_item_init(m, 3, "576i    (576 x 460)");
405         i->on_execute = ps3_svm_cb;
406         i->data = (void *)6;
407
408         i = pmenu_item_init(m, 4, "576p    (576 x 460)");
409         i->on_execute = ps3_svm_cb;
410         i->data = (void *)7;
411
412         i = pmenu_item_init(m, 5, "720p   (1124 x 644)");
413         i->on_execute = ps3_svm_cb;
414         i->data = (void *)3;
415
416         i = pmenu_item_init(m, 6, "1080i  (1688 x 964)");
417         i->on_execute = ps3_svm_cb;
418         i->data = (void *)4;
419
420         i = pmenu_item_init(m, 7, "1080p  (1688 x 964)");
421         i->on_execute = ps3_svm_cb;
422         i->data = (void *)5;
423
424         i = pmenu_item_init(m, 8, "wxga   (1280 x 768)");
425         i->on_execute = ps3_svm_cb;
426         i->data = (void *)11;
427
428         i = pmenu_item_init(m, 9, "sxga   (1280 x 1024)");
429         i->on_execute = ps3_svm_cb;
430         i->data = (void *)12;
431
432         i = pmenu_item_init(m, 10, "wuxga  (1920 x 1200)");
433         i->on_execute = ps3_svm_cb;
434         i->data = (void *)13;
435
436         i = pmenu_item_init(m, 11, "Return");
437         i->on_execute = ps3_svm_to_mm_cb;
438
439         result = pmenu_setup(m);
440
441         if (result) {
442                 pb_log("%s:%d: pmenu_setup failed: %s\n", __func__, __LINE__,
443                         strerror(errno));
444                 goto fail_setup;
445         }
446
447         menu_opts_off(m->ncm, O_SHOWDESC);
448         set_menu_mark(m->ncm, " *");
449
450         return m;
451
452 fail_setup:
453         talloc_free(m);
454         return NULL;
455 }
456
457 static struct ps3_cui ps3;
458
459 static void sig_handler(int signum)
460 {
461         DBGS("%d\n", signum);
462
463         switch (signum) {
464         case SIGALRM:
465                 if (ps3.cui)
466                         ui_timer_sigalrm(&ps3.cui->timer);
467                 break;
468         case SIGWINCH:
469                 if (ps3.cui)
470                         cui_resize(ps3.cui);
471                 break;
472         default:
473                 assert(0 && "unknown sig");
474                 /* fall through */
475         case SIGINT:
476         case SIGHUP:
477         case SIGTERM:
478                 if (ps3.cui)
479                         cui_abort(ps3.cui);
480                 break;
481         }
482 }
483
484 /**
485  * main - cui bootloader main routine.
486  */
487
488 int main(int argc, char *argv[])
489 {
490         static struct sigaction sa;
491         static struct opts opts;
492         int result;
493         int cui_result;
494         unsigned int mode;
495         FILE *log;
496
497         result = opts_parse(&opts, argc, argv);
498
499         if (result) {
500                 print_usage();
501                 return EXIT_FAILURE;
502         }
503
504         if (opts.show_help == opt_yes) {
505                 print_usage();
506                 return EXIT_SUCCESS;
507         }
508
509         if (opts.show_version == opt_yes) {
510                 print_version();
511                 return EXIT_SUCCESS;
512         }
513
514         log = fopen(opts.log_file, "a");
515         assert(log);
516         pb_log_set_stream(log);
517
518 #if defined(DEBUG)
519         pb_log_always_flush(1);
520 #endif
521
522         pb_log("--- pb-cui ---\n");
523
524         sa.sa_handler = sig_handler;
525         result = sigaction(SIGALRM, &sa, NULL);
526         result += sigaction(SIGHUP, &sa, NULL);
527         result += sigaction(SIGINT, &sa, NULL);
528         result += sigaction(SIGTERM, &sa, NULL);
529         result += sigaction(SIGWINCH, &sa, NULL);
530
531         if (result) {
532                 pb_log("%s sigaction failed.\n", __func__);
533                 return EXIT_FAILURE;
534         }
535
536         ps3.values = ps3_flash_defaults;
537
538         if (opts.reset_defaults != opt_yes)
539                 ps3.dirty_values = ps3_flash_get_values(&ps3.values);
540
541         result = ps3_get_video_mode(&mode);
542
543         /* Current becomes default if ps3_flash_get_values() failed. */
544
545         if (ps3.dirty_values && !result)
546                 ps3.values.video_mode = mode;
547
548         /* Set mode if not at default. */
549
550         if (!result && (ps3.values.video_mode != (uint16_t)mode))
551                 ps3_set_video_mode(ps3.values.video_mode);
552
553         ps3.cui = cui_init(&ps3, ps3_kexec_cb);
554
555         if (!ps3.cui)
556                 return EXIT_FAILURE;
557
558         ps3.mm = ps3_mm_init(&ps3);
559         ps3.svm = ps3_svm_init(&ps3);
560
561         if (opts.use_timeout != opt_yes
562                 || ps3.values.timeout == ps3_timeout_forever)
563                 ui_timer_disable(&ps3.cui->timer);
564         else {
565                 ps3.cui->timer.update_display = ps3_timer_update;
566                 ui_timer_init(&ps3.cui->timer, ps3.values.timeout);
567         }
568
569         cui_result = cui_run(ps3.cui, ps3.mm, ps3.values.default_item);
570
571         pmenu_delete(ps3.mm);
572         pmenu_delete(ps3.svm);
573
574         if (ps3.dirty_values)
575                 ps3_flash_set_values(&ps3.values);
576
577         talloc_free(ps3.cui);
578
579         pb_log("--- end ---\n");
580
581         return cui_result ? EXIT_FAILURE : EXIT_SUCCESS;
582 }