Replace @return and @param.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
* efi_file_from_path() - open file via device path
*
* @fp: device path
- * @return: EFI_FILE_PROTOCOL for the file or NULL
+ * Return: EFI_FILE_PROTOCOL for the file or NULL
*/
struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp)
{
*
* We do nothing here.
*
- * @param func_ptr Pointer to function being entered
- * @param caller Pointer to function which called this function
+ * func_ptr: Pointer to function being entered
+ * caller: Pointer to function which called this function
*/
void __attribute__((no_instrument_function))
__cyg_profile_func_enter(void *func_ptr, void *caller)
*
* We do nothing here.
*
- * @param func_ptr Pointer to function being entered
- * @param caller Pointer to function which called this function
+ * func_ptr: Pointer to function being entered
+ * caller: Pointer to function which called this function
*/
void __attribute__((no_instrument_function))
__cyg_profile_func_exit(void *func_ptr, void *caller)
* @width: width of rectangle
* @height: height of rectangle
* @delta: length in bytes of a line in the pixel buffer (optional)
- * @return: status code
+ * Return: status code
*/
efi_status_t EFIAPI gop_blt(struct efi_gop *this, struct efi_gop_pixel *buffer,
u32 operation, efi_uintn_t sx,
*
* @handle: handle of the loaded image
* @systab: system table
- * @return: status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systab)
*
* @handle: handle of the loaded image
* @systab: system table
- * @return: status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t image_handle,
struct efi_system_table *systab)
* Check that a test requiring reset exists.
*
* @testname: name of the test
- * @return: test, or NULL if not found
+ * Return: test, or NULL if not found
*/
static bool need_reset(const u16 *testname)
{
* Check that a test exists.
*
* @testname: name of the test
- * @return: test, or NULL if not found
+ * Return: test, or NULL if not found
*/
static struct efi_unit_test *find_test(const u16 *testname)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* A table is installed, updated, removed. The table entry and the
* triggering of events is checked.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
/*
* Reads an Unicode character from the input device.
*
- * @return: Unicode character
+ * Return: Unicode character
*/
u16 efi_st_get_key(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Check tables after ExitBootServices()
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @length: length of the media device node
* @dp: device path
- * @return: status code
+ * Return: status code
*/
static int create_single_node_device_path(unsigned int length,
struct efi_device_path **dp)
* @esrt: pointer to the ESRT
* @img_info: an image_info_descriptor output by the FMP get_image_info
*
- * @return: true if matching ESRT entry is found and if all the ESRT entry fields match the
+ * Return: true if matching ESRT entry is found and if all the ESRT entry fields match the
* corresponding @img_info fields.
*/
static bool lib_test_check_uuid_entry(struct efi_system_resource_table *esrt,
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Uninstall the test FMP.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* Create multiple events in an event group. Signal each event once and check
* that all events are notified once in each round.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Close the events created in setup.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
* Run a 100 ms single shot timer and check that it is called once
* while waiting for 100 ms periodic timer for two periods.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Load and start the application image.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* Call ExitBootServices again and check that the notification function is
* not called again.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t img_handle,
const struct efi_system_table *systable)
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
* @handle: handle of the loaded image
* @systable: system table
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success, EFI_ST_FAILURE for failure
+ * Return: EFI_ST_SUCCESS for success, EFI_ST_FAILURE for failure
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int efi_st_load_file_setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int efi_st_load_file_teardown(void)
{
* Try loading an image via the EFI_LOAD_FILE_PROTOCOL and the
* EFI_LOAD_FILE2_PROTOCOL. Finally execute the image.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int efi_st_load_file_execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Uninstall protocols and free memory.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
*
* Load and start the application image.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @image_handle: handle of the loaded image
* @systable: system table
- * @return: status code
+ * Return: status code
*/
static efi_status_t EFIAPI check_loaded_image_protocol
(efi_handle_t image_handle, struct efi_system_table *systable)
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t handle,
struct efi_system_table *systable)
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* Retrieve available RNG algorithms.
* Retrieve two random values and compare them.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* Set a new value and read it back.
* Set the real time clock back the current time.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* The triggering of the EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event is checked via
* the call count of the notification function.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @buf: IP header
* @len: length of header in bytes
- * @return: checksum
+ * Return: checksum
*/
static unsigned int efi_ip_checksum(const void *buf, size_t len)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
* A DHCP discover message is sent. The test is successful if a
* DHCP reply is received within 10 seconds.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
* Close the timer event created in setup.
* Shut down the network adapter.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
*
* Load and start the application image.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Tear down unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
*
* Load and start the application image.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: status code
+ * Return: status code
*/
static int efi_st_tcg2_setup(const efi_handle_t img_handle,
const struct efi_system_table *systable)
/*
* efi_st_tcg2_teardown() - Tear down unit test
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int efi_st_tcg2_teardown(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Unregister notify function.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
/*
* Execute unit test.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Close the events created in setup.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
* Lower the TPL level and check that the queued notification
* function is called.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
* occurs.
*
* @addr: address to read
- * @return: value at the address
+ * Return: value at the address
*/
static inline u32 deref(u32 *addr)
{
* Execute unit test.
* An unaligned memory access is executed. The result is checked.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup_timer(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* @handle: handle of the loaded image
* @systable: system table
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int setup_reboot(const efi_handle_t handle,
const struct efi_system_table *systable)
*
* Close the events created in setup.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int teardown(void)
{
* Run a 1350 ms single shot timer and check that the 600ms timer has
* been called 2 times.
*
- * @return: EFI_ST_SUCCESS for success
+ * Return: EFI_ST_SUCCESS for success
*/
static int execute(void)
{
*
* @handle: handle of the loaded image
* @systab: system table
- * @return: status code
+ * Return: status code
*/
efi_status_t EFIAPI efi_main(efi_handle_t image_handle,
struct efi_system_table *systab)