1 // SPDX-License-Identifier: GPL-2.0+
3 * Implementation of configuration editor
5 * Copyright 2023 Google LLC
9 #define LOG_CATEGORY LOGC_EXPO
21 #include <linux/delay.h>
22 #include "scene_internal.h"
26 CMOS_MAX_BYTES = CMOS_MAX_BITS / 8,
29 #define CMOS_BYTE(bit) ((bit) / 8)
30 #define CMOS_BIT(bit) ((bit) % 8)
33 * struct cedit_iter_priv - private data for cedit operations
35 * @buf: Buffer to use when writing settings to the devicetree
36 * @node: Node to read from when reading settings from devicetree
37 * @verbose: true to show writing to environment variables
38 * @mask: Mask bits for the CMOS RAM. If a bit is set the byte containing it
40 * @value: Value bits for CMOS RAM. This is the actual value written
41 * @dev: RTC device to write to
43 struct cedit_iter_priv {
52 int cedit_arange(struct expo *exp, struct video_priv *vpriv, uint scene_id)
54 struct scene_obj_txt *txt;
55 struct scene_obj *obj;
59 scn = expo_lookup_scene_id(exp, scene_id);
61 return log_msg_ret("scn", -ENOENT);
63 txt = scene_obj_find_by_name(scn, "prompt");
65 scene_obj_set_pos(scn, txt->obj.id, 0, vpriv->ysize - 50);
67 txt = scene_obj_find_by_name(scn, "title");
69 scene_obj_set_pos(scn, txt->obj.id, 200, 10);
72 list_for_each_entry(obj, &scn->obj_head, sibling) {
79 scene_obj_set_pos(scn, obj->id, 50, y);
80 scene_menu_arrange(scn, (struct scene_obj_menu *)obj);
83 case SCENEOBJT_TEXTLINE:
84 scene_obj_set_pos(scn, obj->id, 50, y);
85 scene_textline_arrange(scn,
86 (struct scene_obj_textline *)obj);
95 int cedit_prepare(struct expo *exp, struct video_priv **vid_privp,
98 struct video_priv *vid_priv;
104 /* For now we only support a video console */
105 ret = uclass_first_device_err(UCLASS_VIDEO, &dev);
107 return log_msg_ret("vid", ret);
108 ret = expo_set_display(exp, dev);
110 return log_msg_ret("dis", ret);
112 ret = expo_first_scene_id(exp);
114 return log_msg_ret("scn", ret);
117 ret = expo_set_scene_id(exp, scene_id);
119 return log_msg_ret("sid", ret);
123 /* This is not supported for now */
125 expo_set_text_mode(exp, true);
127 vid_priv = dev_get_uclass_priv(dev);
129 scn = expo_lookup_scene_id(exp, scene_id);
130 scene_highlight_first(scn);
132 cedit_arange(exp, vid_priv, scene_id);
134 ret = expo_calc_dims(exp);
136 return log_msg_ret("dim", ret);
138 *vid_privp = vid_priv;
144 int cedit_run(struct expo *exp)
146 struct cli_ch_state s_cch, *cch = &s_cch;
147 struct video_priv *vid_priv;
154 ret = cedit_prepare(exp, &vid_priv, &scn);
156 return log_msg_ret("prep", ret);
161 struct expo_action act;
164 ret = expo_render(exp);
168 ichar = cli_ch_process(cch, 0);
170 while (!ichar && !tstc()) {
173 ichar = cli_ch_process(cch, -ETIMEDOUT);
177 ichar = cli_ch_process(cch, ichar);
183 key = bootmenu_conv_key(ichar);
184 if (key == BKEY_NONE || key >= BKEY_FIRST_EXTRA)
190 ret = expo_send_key(exp, key);
194 ret = expo_action_get(exp, &act);
197 case EXPOACT_POINT_OBJ:
198 scene_set_highlight_id(scn, act.select.id);
199 cedit_arange(exp, vid_priv, scene_id);
202 scene_set_open(scn, act.select.id, true);
203 cedit_arange(exp, vid_priv, scene_id);
206 scene_set_open(scn, act.select.id, false);
207 cedit_arange(exp, vid_priv, scene_id);
210 scene_set_open(scn, scn->highlight_id, false);
211 cedit_arange(exp, vid_priv, scene_id);
214 log_debug("quitting\n");
224 return log_msg_ret("end", ret);
229 static int check_space(int ret, struct abuf *buf)
231 if (ret == -FDT_ERR_NOSPACE) {
232 if (!abuf_realloc_inc(buf, CEDIT_SIZE_INC))
233 return log_msg_ret("spc", -ENOMEM);
234 ret = fdt_resize(abuf_data(buf), abuf_data(buf),
237 return log_msg_ret("res", -EFAULT);
244 * get_cur_menuitem_text() - Get the text of the currently selected item
246 * Looks up the object for the current item, finds text object for it and looks
247 * up the string for that text
249 * @menu: Menu to look at
250 * @strp: Returns a pointer to the next
251 * Return: 0 if OK, -ENOENT if something was not found
253 static int get_cur_menuitem_text(const struct scene_obj_menu *menu,
256 struct scene *scn = menu->obj.scene;
257 const struct scene_menitem *mi;
258 const struct scene_obj_txt *txt;
261 mi = scene_menuitem_find(menu, menu->cur_item_id);
263 return log_msg_ret("mi", -ENOENT);
265 txt = scene_obj_find(scn, mi->label_id, SCENEOBJT_TEXT);
267 return log_msg_ret("txt", -ENOENT);
269 str = expo_get_str(scn->expo, txt->str_id);
271 return log_msg_ret("str", -ENOENT);
277 static int write_dt_string(struct abuf *buf, const char *name, const char *str)
281 /* write the text of the current item */
283 for (i = 0; ret && i < 2; i++) {
284 ret = fdt_property_string(abuf_data(buf), name, str);
286 ret = check_space(ret, buf);
288 return log_msg_ret("rs2", -ENOMEM);
292 /* this should not happen */
294 return log_msg_ret("str", -EFAULT);
299 static int h_write_settings(struct scene_obj *obj, void *vpriv)
301 struct cedit_iter_priv *priv = vpriv;
302 struct abuf *buf = priv->buf;
307 case SCENEOBJT_IMAGE:
310 case SCENEOBJT_TEXTLINE: {
311 const struct scene_obj_textline *tline;
313 tline = (struct scene_obj_textline *)obj;
314 ret = write_dt_string(buf, obj->name, abuf_data(&tline->buf));
316 return log_msg_ret("wr2", ret);
319 case SCENEOBJT_MENU: {
320 const struct scene_obj_menu *menu;
325 /* write the ID of the current item */
326 menu = (struct scene_obj_menu *)obj;
328 for (i = 0; ret && i < 2; i++) {
329 ret = fdt_property_u32(abuf_data(buf), obj->name,
332 ret = check_space(ret, buf);
334 return log_msg_ret("res", -ENOMEM);
337 /* this should not happen */
339 return log_msg_ret("wrt", -EFAULT);
341 ret = get_cur_menuitem_text(menu, &str);
343 return log_msg_ret("mis", ret);
345 /* write the text of the current item */
346 snprintf(name, sizeof(name), "%s-str", obj->name);
347 ret = write_dt_string(buf, name, str);
349 return log_msg_ret("wr2", ret);
358 int cedit_write_settings(struct expo *exp, struct abuf *buf)
360 struct cedit_iter_priv priv;
365 if (!abuf_realloc(buf, CEDIT_SIZE_INC))
366 return log_msg_ret("buf", -ENOMEM);
368 fdt = abuf_data(buf);
369 ret = fdt_create(fdt, abuf_size(buf));
371 ret = fdt_finish_reservemap(fdt);
373 ret = fdt_begin_node(fdt, "");
375 ret = fdt_begin_node(fdt, CEDIT_NODE_NAME);
377 log_debug("Failed to start FDT (err=%d)\n", ret);
378 return log_msg_ret("sta", -EINVAL);
381 /* write out the items */
383 ret = expo_iter_scene_objs(exp, h_write_settings, &priv);
385 log_debug("Failed to write settings (err=%d)\n", ret);
386 return log_msg_ret("set", ret);
389 ret = fdt_end_node(fdt);
391 ret = fdt_end_node(fdt);
393 ret = fdt_finish(fdt);
395 log_debug("Failed to finish FDT (err=%d)\n", ret);
396 return log_msg_ret("fin", -EINVAL);
402 static int h_read_settings(struct scene_obj *obj, void *vpriv)
404 struct cedit_iter_priv *priv = vpriv;
405 ofnode node = priv->node;
409 case SCENEOBJT_IMAGE:
412 case SCENEOBJT_TEXTLINE: {
413 const struct scene_obj_textline *tline;
417 tline = (struct scene_obj_textline *)obj;
419 val = ofnode_read_prop(node, obj->name, &len);
420 if (len >= tline->max_chars)
421 return log_msg_ret("str", -ENOSPC);
422 strcpy(abuf_data(&tline->buf), val);
425 case SCENEOBJT_MENU: {
426 struct scene_obj_menu *menu;
429 if (ofnode_read_u32(node, obj->name, &val))
430 return log_msg_ret("rd", -ENOENT);
431 menu = (struct scene_obj_menu *)obj;
432 menu->cur_item_id = val;
441 int cedit_read_settings(struct expo *exp, oftree tree)
443 struct cedit_iter_priv priv;
447 root = oftree_root(tree);
448 if (!ofnode_valid(root))
449 return log_msg_ret("roo", -ENOENT);
450 node = ofnode_find_subnode(root, CEDIT_NODE_NAME);
451 if (!ofnode_valid(node))
452 return log_msg_ret("pat", -ENOENT);
454 /* read in the items */
456 ret = expo_iter_scene_objs(exp, h_read_settings, &priv);
458 log_debug("Failed to read settings (err=%d)\n", ret);
459 return log_msg_ret("set", ret);
465 static int h_write_settings_env(struct scene_obj *obj, void *vpriv)
467 const struct scene_obj_menu *menu;
468 struct cedit_iter_priv *priv = vpriv;
469 char name[80], var[60];
473 snprintf(var, sizeof(var), "c.%s", obj->name);
477 case SCENEOBJT_IMAGE:
481 menu = (struct scene_obj_menu *)obj;
482 val = menu->cur_item_id;
485 printf("%s=%d\n", var, val);
487 ret = env_set_ulong(var, val);
489 return log_msg_ret("set", ret);
491 ret = get_cur_menuitem_text(menu, &str);
493 return log_msg_ret("mis", ret);
495 snprintf(name, sizeof(name), "c.%s-str", obj->name);
497 printf("%s=%s\n", name, str);
499 ret = env_set(name, str);
501 return log_msg_ret("st2", ret);
503 case SCENEOBJT_TEXTLINE: {
504 const struct scene_obj_textline *tline;
506 tline = (struct scene_obj_textline *)obj;
507 str = abuf_data(&tline->buf);
508 ret = env_set(var, str);
510 return log_msg_ret("set", ret);
513 printf("%s=%s\n", var, str);
522 int cedit_write_settings_env(struct expo *exp, bool verbose)
524 struct cedit_iter_priv priv;
527 /* write out the items */
528 priv.verbose = verbose;
529 ret = expo_iter_scene_objs(exp, h_write_settings_env, &priv);
531 log_debug("Failed to write settings to env (err=%d)\n", ret);
532 return log_msg_ret("set", ret);
538 static int h_read_settings_env(struct scene_obj *obj, void *vpriv)
540 struct cedit_iter_priv *priv = vpriv;
541 struct scene_obj_menu *menu;
545 snprintf(var, sizeof(var), "c.%s", obj->name);
549 case SCENEOBJT_IMAGE:
553 menu = (struct scene_obj_menu *)obj;
554 val = env_get_ulong(var, 10, 0);
556 printf("%s=%d\n", var, val);
558 return log_msg_ret("get", -ENOENT);
561 * note that no validation is done here, to make sure the ID is
562 * valid * and actually points to a menu item
564 menu->cur_item_id = val;
566 case SCENEOBJT_TEXTLINE: {
567 const struct scene_obj_textline *tline;
570 tline = (struct scene_obj_textline *)obj;
571 value = env_get(var);
572 if (value && strlen(value) >= tline->max_chars)
573 return log_msg_ret("str", -ENOSPC);
577 printf("%s=%s\n", var, value);
578 strcpy(abuf_data(&tline->buf), value);
586 int cedit_read_settings_env(struct expo *exp, bool verbose)
588 struct cedit_iter_priv priv;
591 /* write out the items */
592 priv.verbose = verbose;
593 ret = expo_iter_scene_objs(exp, h_read_settings_env, &priv);
595 log_debug("Failed to read settings from env (err=%d)\n", ret);
596 return log_msg_ret("set", ret);
603 * get_cur_menuitem_seq() - Get the sequence number of a menu's current item
605 * Enumerates the items of a menu (0, 1, 2) and returns the sequence number of
606 * the currently selected item. If the first item is selected, this returns 0;
607 * if the second, 1; etc.
609 * @menu: Menu to check
610 * Return: Sequence number on success, else -ve error value
612 static int get_cur_menuitem_seq(const struct scene_obj_menu *menu)
614 const struct scene_menitem *mi;
619 list_for_each_entry(mi, &menu->item_head, sibling) {
620 if (mi->id == menu->cur_item_id) {
628 return log_msg_ret("nf", -ENOENT);
633 static int h_write_settings_cmos(struct scene_obj *obj, void *vpriv)
635 const struct scene_obj_menu *menu;
636 struct cedit_iter_priv *priv = vpriv;
640 if (obj->type != SCENEOBJT_MENU)
643 menu = (struct scene_obj_menu *)obj;
644 val = menu->cur_item_id;
646 ret = get_cur_menuitem_seq(menu);
648 return log_msg_ret("cur", ret);
650 log_debug("%s: seq=%d\n", menu->obj.name, seq);
652 /* figure out where to place this item */
653 if (!obj->bit_length)
654 return log_msg_ret("len", -EINVAL);
655 if (obj->start_bit + obj->bit_length > CMOS_MAX_BITS)
656 return log_msg_ret("bit", -E2BIG);
658 for (i = 0; i < obj->bit_length; i++, seq >>= 1) {
659 uint bitnum = obj->start_bit + i;
661 priv->mask[CMOS_BYTE(bitnum)] |= 1 << CMOS_BIT(bitnum);
663 priv->value[CMOS_BYTE(bitnum)] |= BIT(CMOS_BIT(bitnum));
664 log_debug("bit %x %x %x\n", bitnum,
665 priv->mask[CMOS_BYTE(bitnum)],
666 priv->value[CMOS_BYTE(bitnum)]);
672 int cedit_write_settings_cmos(struct expo *exp, struct udevice *dev,
675 struct cedit_iter_priv priv;
676 int ret, i, count, first, last;
678 /* write out the items */
679 priv.mask = calloc(1, CMOS_MAX_BYTES);
681 return log_msg_ret("mas", -ENOMEM);
682 priv.value = calloc(1, CMOS_MAX_BYTES);
685 return log_msg_ret("val", -ENOMEM);
688 ret = expo_iter_scene_objs(exp, h_write_settings_cmos, &priv);
690 log_debug("Failed to write CMOS (err=%d)\n", ret);
691 ret = log_msg_ret("set", ret);
695 /* write the data to the RTC */
696 first = CMOS_MAX_BYTES;
698 for (i = 0, count = 0; i < CMOS_MAX_BYTES; i++) {
700 log_debug("Write byte %x: %x\n", i, priv.value[i]);
701 ret = rtc_write8(dev, i, priv.value[i]);
703 ret = log_msg_ret("wri", ret);
707 first = min(first, i);
712 printf("Write %d bytes from offset %x to %x\n", count, first,
722 static int h_read_settings_cmos(struct scene_obj *obj, void *vpriv)
724 struct cedit_iter_priv *priv = vpriv;
725 const struct scene_menitem *mi;
726 struct scene_obj_menu *menu;
730 if (obj->type != SCENEOBJT_MENU)
733 menu = (struct scene_obj_menu *)obj;
735 /* figure out where to place this item */
736 if (!obj->bit_length)
737 return log_msg_ret("len", -EINVAL);
738 if (obj->start_bit + obj->bit_length > CMOS_MAX_BITS)
739 return log_msg_ret("bit", -E2BIG);
742 for (i = 0; i < obj->bit_length; i++) {
743 uint bitnum = obj->start_bit + i;
744 uint offset = CMOS_BYTE(bitnum);
746 /* read the byte if not already read */
747 if (!priv->mask[offset]) {
748 ret = rtc_read8(priv->dev, offset);
750 return log_msg_ret("rea", ret);
751 priv->value[offset] = ret;
753 /* mark it as read */
754 priv->mask[offset] = 0xff;
757 if (priv->value[offset] & BIT(CMOS_BIT(bitnum)))
759 log_debug("bit %x %x\n", bitnum, val);
762 /* update the current item */
763 mi = scene_menuitem_find_seq(menu, val);
765 return log_msg_ret("seq", -ENOENT);
767 menu->cur_item_id = mi->id;
768 log_debug("Update menu %d cur_item_id %d\n", menu->obj.id, mi->id);
773 int cedit_read_settings_cmos(struct expo *exp, struct udevice *dev,
776 struct cedit_iter_priv priv;
777 int ret, i, count, first, last;
779 /* read in the items */
780 priv.mask = calloc(1, CMOS_MAX_BYTES);
782 return log_msg_ret("mas", -ENOMEM);
783 priv.value = calloc(1, CMOS_MAX_BYTES);
786 return log_msg_ret("val", -ENOMEM);
790 ret = expo_iter_scene_objs(exp, h_read_settings_cmos, &priv);
792 log_debug("Failed to read CMOS (err=%d)\n", ret);
793 ret = log_msg_ret("set", ret);
797 /* read the data to the RTC */
798 first = CMOS_MAX_BYTES;
800 for (i = 0, count = 0; i < CMOS_MAX_BYTES; i++) {
802 log_debug("Read byte %x: %x\n", i, priv.value[i]);
804 first = min(first, i);
809 printf("Read %d bytes from offset %x to %x\n", count, first,