Open Menu / include / extlinux.h
Loading...
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Copyright 2021 Google LLC
 * Written by Simon Glass <sjg@chromium.org>
 */

#ifndef __extlinux_h
#define __extlinux_h

#include <pxe_utils.h>

#define EXTLINUX_FNAME	"extlinux/extlinux.conf"

/**
 * struct extlinux_info - useful information for extlinux_getfile()
 *
 * @dev: bootmethod device being used to boot
 * @bflow: bootflow being booted
 */
struct extlinux_info {
	struct udevice *dev;
	struct bootflow *bflow;
};

/**
 * struct extlinux_plat - platform data for this bootmeth
 *
 * @use_falllback: true to boot with the fallback option
 * @info: information used for the getfile() method
 */
struct extlinux_plat {
	bool use_fallback;
	struct extlinux_info info;
};

/**
 * struct extlinux_priv - private runtime data for this bootmeth
 *
 * @ctxs: list of parsed PXE contexts (alist of struct pxe_context), one per
 *	extlinux.conf file found during scanning
 */
struct extlinux_priv {
	struct alist ctxs;
};

/**
 * extlinux_bootmeth_probe() - Probe function for extlinux-based bootmeths
 *
 * Initialises the context alist in extlinux_priv. Must be called from the
 * probe function of any driver that uses extlinux_priv.
 *
 * @dev: Bootmethod device
 * Return: 0 if OK
 */
int extlinux_bootmeth_probe(struct udevice *dev);

/**
 * extlinux_bootmeth_remove() - Remove function for extlinux-based bootmeths
 *
 * Frees all cached PXE contexts in the alist.
 *
 * @dev: Bootmethod device
 * Return: 0 if OK
 */
int extlinux_bootmeth_remove(struct udevice *dev);

/**
 * extlinux_get_ctx() - Get or allocate a PXE context for a bootflow
 *
 * If bflow->bootmeth_id already points to a valid context (e.g. from a
 * prior read_all), return it. Otherwise allocate a new context in the
 * alist and store its index in bflow->bootmeth_id.
 *
 * @priv: Private data for this bootmeth
 * @bflow: Bootflow to get context for
 * Return: Context, or NULL on allocation failure
 */
struct pxe_context *extlinux_get_ctx(struct extlinux_priv *priv,
				     struct bootflow *bflow);

/**
 * extlinux_set_property() - set an extlinux property
 *
 * This allows the setting of bootmeth-specific properties to enable
 * automated finer-grained control of the boot process
 *
 * @name: String containing the name of the relevant boot method
 * @property: String containing the name of the property to set
 * @value: String containing the value to be set for the specified property
 * Return: 0 if OK, -EINVAL if an unknown property or invalid value is provided
 */
int extlinux_set_property(struct udevice *dev, const char *property,
			  const char *value);

/**
 * extlinux_boot() - Boot a bootflow
 *
 * @dev: bootmeth device
 * @bflow: Bootflow to boot
 * @ctx: PXE context to use for booting
 * @getfile: Function to use to read files
 * @allow_abs_path: true to allow absolute paths
 * @bootfile: Bootfile whose directory loaded files are relative to, NULL if
 *	none
 * @restart: true to use BOOTM_STATE_RESTART instead of BOOTM_STATE_START (only
 *	supported with FIT / bootm)
 * Return: 0 if OK, -ve error code on failure
 */
int extlinux_boot(struct udevice *dev, struct bootflow *bflow,
		  struct pxe_context *ctx, pxe_getfile_func getfile,
		  bool allow_abs_path, const char *bootfile, bool restart);

/**
 * extlinux_read_all() - read all files for a bootflow
 *
 * @dev: Bootmethod device to boot
 * @bflow: Bootflow to read
 * @ctx: PXE context to use for reading
 * @getfile: Function to use to read files
 * @allow_abs_path: true to allow absolute paths
 * @bootfile: Bootfile whose directory loaded files are relative to, NULL if
 *	none
 * Return: 0 if OK, -EIO on I/O error, other -ve on other error
 */
int extlinux_read_all(struct udevice *dev, struct bootflow *bflow,
		      struct pxe_context *ctx, pxe_getfile_func getfile,
		      bool allow_abs_path, const char *bootfile);

#endif