blob: f261207e2097db6c297051155182b992e35a1e69 [file] [log] [blame]
Simon Glass040b0462023-08-14 16:40:25 -06001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright 2023 Google LLC
4 * Written by Simon Glass <sjg@chromium.org>
5 */
6
7#ifndef __CEDIT_H
8#define __CEDIT_H
9
Simon Glass472317c2023-08-14 16:40:34 -060010#include <dm/ofnode_decl.h>
11
Simon Glass2dee81f2023-08-14 16:40:33 -060012struct abuf;
Simon Glass040b0462023-08-14 16:40:25 -060013struct expo;
Simon Glass8d0f8902023-08-14 16:40:27 -060014struct scene;
Simon Glass040b0462023-08-14 16:40:25 -060015struct video_priv;
16
Simon Glass2dee81f2023-08-14 16:40:33 -060017enum {
18 /* size increment for writing FDT */
19 CEDIT_SIZE_INC = 1024,
20};
21
22/* Name of the cedit node in the devicetree */
23#define CEDIT_NODE_NAME "cedit-values"
24
25extern struct expo *cur_exp;
26
Simon Glass040b0462023-08-14 16:40:25 -060027/**
28 * cedit_arange() - Arrange objects in a configuration-editor scene
29 *
30 * @exp: Expo to update
31 * @vid_priv: Private info of the video device
32 * @scene_id: scene ID to arrange
33 * Returns: 0 if OK, -ve on error
34 */
35int cedit_arange(struct expo *exp, struct video_priv *vid_priv, uint scene_id);
36
37/**
38 * cedit_run() - Run a configuration editor
39 *
40 * This accepts input until the user quits with Escape
41 *
42 * @exp: Expo to use
43 * Returns: 0 if OK, -ve on error
44 */
45int cedit_run(struct expo *exp);
46
Simon Glass8d0f8902023-08-14 16:40:27 -060047/**
48 * cedit_prepare() - Prepare to run a cedit
49 *
50 * Set up the video device, select the first scene and highlight the first item.
51 * This ensures that all menus have a selected item.
52 *
53 * @exp: Expo to use
54 * @vid_privp: Set to private data for the video device
55 * @scnp: Set to the first scene
56 * Return: scene ID of first scene if OK, -ve on error
57 */
58int cedit_prepare(struct expo *exp, struct video_priv **vid_privp,
59 struct scene **scnp);
60
Simon Glass2dee81f2023-08-14 16:40:33 -060061/**
62 * cedit_write_settings() - Write settings in FDT format
63 *
64 * Sets up an FDT with the settings
65 *
66 * @exp: Expo to write settings from
67 * @buf: Returns abuf containing the settings FDT (inited by this function)
68 * Return: 0 if OK, -ve on error
69 */
70int cedit_write_settings(struct expo *exp, struct abuf *buf);
71
Simon Glass472317c2023-08-14 16:40:34 -060072/**
73 * cedit_read_settings() - Read settings in FDT format
74 *
75 * Read an FDT with the settings
76 *
77 * @exp: Expo to read settings into
78 * @tree: Tree to read from
79 * Return: 0 if OK, -ve on error
80 */
81int cedit_read_settings(struct expo *exp, oftree tree);
82
Simon Glassfc9c0e02023-08-14 16:40:35 -060083/**
84 * cedit_write_settings_env() - Write settings to envrionment variables
85 *
86 * @exp: Expo to write settings from
87 * @verbose: true to print each var as it is set
88 * Return: 0 if OK, -ve on error
89 */
90int cedit_write_settings_env(struct expo *exp, bool verbose);
91
Simon Glass040b0462023-08-14 16:40:25 -060092#endif /* __CEDIT_H */