Heinrich Schuchardt
a2fda5145f
`make htmldocs` reports
./include/sandbox_host.h:14: warning:
cannot understand function prototype: 'enum host_platform_flags '
Align the description with Sphinx style.
Fixes: 93e9af685f ("test: bootdev: scan with a broken high-priority device")
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Denis Mukhin <dmukhin@ford.com>
146 lines
3.9 KiB
C
146 lines
3.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* sandbox host uclass
|
|
*
|
|
* Copyright 2022 Google LLC
|
|
*/
|
|
|
|
#ifndef __SANDBOX_HOST__
|
|
#define __SANDBOX_HOST__
|
|
|
|
/**
|
|
* enum host_platform_flags - device flags
|
|
*
|
|
*/
|
|
enum host_platform_flags {
|
|
/** @HOST_FLAG_BROKEN: simulate broken device */
|
|
HOST_FLAG_BROKEN = BIT(0),
|
|
};
|
|
|
|
/**
|
|
* struct host_sb_plat - platform data for a host device
|
|
*
|
|
* @label: Label for this device (allocated)
|
|
* @filename: Name of file this is attached to, or NULL (allocated)
|
|
* @fd: File descriptor of file, or 0 for none (file is not open)
|
|
* @flags: Device flags (e.g. for unit tests).
|
|
*/
|
|
struct host_sb_plat {
|
|
char *label;
|
|
char *filename;
|
|
int fd;
|
|
unsigned int flags;
|
|
};
|
|
|
|
/**
|
|
* struct host_ops - operations supported by UCLASS_HOST
|
|
*/
|
|
struct host_ops {
|
|
/**
|
|
* @attach_file: - Attach a new file to the device
|
|
*
|
|
* @attach_file.dev: Device to update
|
|
* @attach_file.filename: Name of the file, e.g. "/path/to/disk.img"
|
|
* @attach_file.Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
|
|
* other error
|
|
*/
|
|
int (*attach_file)(struct udevice *dev, const char *filename);
|
|
|
|
/**
|
|
* @detach_file: - Detach a file from the device
|
|
*
|
|
* @detach_file.dev: Device to detach from
|
|
* @detach_file.Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
|
|
* error
|
|
*/
|
|
int (*detach_file)(struct udevice *dev);
|
|
};
|
|
|
|
#define host_get_ops(dev) ((struct host_ops *)(dev)->driver->ops)
|
|
|
|
/**
|
|
* host_attach_file() - Attach a new file to the device
|
|
*
|
|
* @dev: Device to update
|
|
* @filename: Name of the file, e.g. "/path/to/disk.img"
|
|
* Returns: 0 if OK, -EEXIST if a file is already attached, other -ve on
|
|
* other error
|
|
*/
|
|
int host_attach_file(struct udevice *dev, const char *filename);
|
|
|
|
/**
|
|
* host_detach_file() - Detach a file from the device
|
|
*
|
|
* @dev: Device to detach from
|
|
* Returns: 0 if OK, -ENOENT if no file is attached, other -ve on other
|
|
* error
|
|
*/
|
|
int host_detach_file(struct udevice *dev);
|
|
|
|
/**
|
|
* host_create_device() - Create a new host device
|
|
*
|
|
* Any existing device with the same label is removed and unbound first
|
|
*
|
|
* @label: Label of the attachment, e.g. "test1"
|
|
* @removable: true if the device should be marked as removable, false
|
|
* if it is fixed. See enum blk_flag_t
|
|
* @blksz: logical block size of the device
|
|
* @devp: Returns the device created, on success
|
|
* Returns: 0 if OK, -ve on error
|
|
*/
|
|
int host_create_device(const char *label, bool removable, unsigned long blksz,
|
|
struct udevice **devp);
|
|
|
|
/**
|
|
* host_create_attach_file() - Create a new host device attached to a file
|
|
*
|
|
* @label: Label of the attachment, e.g. "test1"
|
|
* @filename: Name of the file, e.g. "/path/to/disk.img"
|
|
* @removable: true if the device should be marked as removable, false
|
|
* if it is fixed. See enum blk_flag_t
|
|
* @blksz: logical block size of the device
|
|
* @devp: Returns the device created, on success
|
|
* Returns: 0 if OK, -ve on error
|
|
*/
|
|
int host_create_attach_file(const char *label, const char *filename,
|
|
bool removable, unsigned long blksz,
|
|
struct udevice **devp);
|
|
|
|
/**
|
|
* host_find_by_label() - Find a host by label
|
|
*
|
|
* Searches all host devices to find one with the given label
|
|
*
|
|
* @label: Label to find
|
|
* Returns: associated device, or NULL if not found
|
|
*/
|
|
struct udevice *host_find_by_label(const char *label);
|
|
|
|
/**
|
|
* host_get_cur_dev() - Get the current device
|
|
*
|
|
* Returns current device, or NULL if none
|
|
*/
|
|
struct udevice *host_get_cur_dev(void);
|
|
|
|
/**
|
|
* host_set_cur_dev() - Set the current device
|
|
*
|
|
* Sets the current device, or clears it if @dev is NULL
|
|
*
|
|
* @dev: Device to set as the current one
|
|
*/
|
|
void host_set_cur_dev(struct udevice *dev);
|
|
|
|
/**
|
|
* host_set_flags_by_label() - Set the host device test flags
|
|
*
|
|
* @label: Label of the attachment, e.g. "test1"
|
|
* @flags: Device flags
|
|
* Returns: 0 if OK, -ve on error
|
|
*/
|
|
int host_set_flags_by_label(const char *label, unsigned int flags);
|
|
|
|
#endif /* __SANDBOX_HOST__ */
|