[people/ms/u-boot.git] / lib / efi_selftest / efi_selftest_tpl.c

/*
 * efi_selftest_events
 *
 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
 *
 * SPDX-License-Identifier:     GPL-2.0+
 *
 * This unit test uses timer events to check the handling of
 * task priority levels.
 */

#include <efi_selftest.h>

static struct efi_event *event_notify;
static struct efi_event *event_wait;
static unsigned int notification_count;
static struct efi_boot_services *boottime;

/*
 * Notification function, increments the notification count.
 *
 * @event	notified event
 * @context	pointer to the notification count
 */
static void EFIAPI notify(struct efi_event *event, void *context)
{
	unsigned int *count = context;

	if (count)
		++*count;
}

/*
 * Setup unit test.
 *
 * Create two timer events.
 * One with EVT_NOTIFY_SIGNAL, the other with EVT_NOTIFY_WAIT.
 *
 * @handle:	handle of the loaded image
 * @systable:	system table
 * @return:	EFI_ST_SUCCESS for success
 */
static int setup(const efi_handle_t handle,
		 const struct efi_system_table *systable)
{
	efi_status_t ret;

	boottime = systable->boottime;

	ret = boottime->create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL,
				     TPL_CALLBACK, notify,
				     (void *)&notification_count,
				     &event_notify);
	if (ret != EFI_SUCCESS) {
		efi_st_error("could not create event\n");
		return EFI_ST_FAILURE;
	}
	ret = boottime->create_event(EVT_TIMER | EVT_NOTIFY_WAIT,
				     TPL_HIGH_LEVEL, notify, NULL, &event_wait);
	if (ret != EFI_SUCCESS) {
		efi_st_error("could not create event\n");
		return EFI_ST_FAILURE;
	}
	return EFI_ST_SUCCESS;
}

/*
 * Tear down unit test.
 *
 * Close the events created in setup.
 *
 * @return:	EFI_ST_SUCCESS for success
 */
static int teardown(void)
{
	efi_status_t ret;

	if (event_notify) {
		ret = boottime->close_event(event_notify);
		event_notify = NULL;
		if (ret != EFI_SUCCESS) {
			efi_st_error("could not close event\n");
			return EFI_ST_FAILURE;
		}
	}
	if (event_wait) {
		ret = boottime->close_event(event_wait);
		event_wait = NULL;
		if (ret != EFI_SUCCESS) {
			efi_st_error("could not close event\n");
			return EFI_ST_FAILURE;
		}
	}
	boottime->restore_tpl(TPL_APPLICATION);
	return EFI_ST_SUCCESS;
}

/*
 * Execute unit test.
 *
 * Run a 10 ms periodic timer and check that it is called 10 times
 * while waiting for 100 ms single shot timer.
 *
 * Raise the TPL level to the level of the 10 ms timer and observe
 * that the notification function is not called again.
 *
 * Lower the TPL level and check that the queued notification
 * function is called.
 *
 * @return:	EFI_ST_SUCCESS for success
 */
static int execute(void)
{
	efi_uintn_t index;
	efi_status_t ret;
	efi_uintn_t old_tpl;

	/* Set 10 ms timer */
	notification_count = 0;
	ret = boottime->set_timer(event_notify, EFI_TIMER_PERIODIC, 100000);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not set timer\n");
		return EFI_ST_FAILURE;
	}
	/* Set 100 ms timer */
	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000000);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not set timer\n");
		return EFI_ST_FAILURE;
	}
	index = 5;
	ret = boottime->wait_for_event(1, &event_wait, &index);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not wait for event\n");
		return EFI_ST_FAILURE;
	}
	ret = boottime->check_event(event_wait);
	if (ret != EFI_NOT_READY) {
		efi_st_error("Signaled state was not cleared.\n");
		efi_st_printf("ret = %u\n", (unsigned int)ret);
		return EFI_ST_FAILURE;
	}
	if (index != 0) {
		efi_st_error("WaitForEvent returned wrong index\n");
		return EFI_ST_FAILURE;
	}
	efi_st_printf("Notification count with TPL level TPL_APPLICATION: %u\n",
		      notification_count);
	if (notification_count < 8 || notification_count > 12) {
		efi_st_error("Incorrect timing of events\n");
		return EFI_ST_FAILURE;
	}
	ret = boottime->set_timer(event_notify, EFI_TIMER_STOP, 0);
	if (index != 0) {
		efi_st_error("Could not cancel timer\n");
		return EFI_ST_FAILURE;
	}
	/* Raise TPL level */
	old_tpl = boottime->raise_tpl(TPL_CALLBACK);
	if (old_tpl != TPL_APPLICATION) {
		efi_st_error("Initial TPL level was not TPL_APPLICATION");
		return EFI_ST_FAILURE;
	}
	/* Set 10 ms timer */
	notification_count = 0;
	ret = boottime->set_timer(event_notify, EFI_TIMER_PERIODIC, 100000);
	if (index != 0) {
		efi_st_error("Could not set timer\n");
		return EFI_ST_FAILURE;
	}
	/* Set 100 ms timer */
	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000000);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not set timer\n");
		return EFI_ST_FAILURE;
	}
	do {
		ret = boottime->check_event(event_wait);
	} while (ret == EFI_NOT_READY);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not check event\n");
		return EFI_ST_FAILURE;
	}
	efi_st_printf("Notification count with TPL level TPL_CALLBACK: %u\n",
		      notification_count);
	if (notification_count != 0) {
		efi_st_error("Suppressed timer fired\n");
		return EFI_ST_FAILURE;
	}
	/* Set 1 ms timer */
	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not set timer\n");
		return EFI_ST_FAILURE;
	}
	/* Restore the old TPL level */
	boottime->restore_tpl(TPL_APPLICATION);
	ret = boottime->wait_for_event(1, &event_wait, &index);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not wait for event\n");
		return EFI_ST_FAILURE;
	}
	efi_st_printf("Notification count with TPL level TPL_APPLICATION: %u\n",
		      notification_count);
	if (notification_count < 1) {
		efi_st_error("Queued timer event did not fire\n");
		return EFI_ST_FAILURE;
	}
	ret = boottime->set_timer(event_wait, EFI_TIMER_STOP, 0);
	if (ret != EFI_SUCCESS) {
		efi_st_error("Could not cancel timer\n");
		return EFI_ST_FAILURE;
	}

	return EFI_ST_SUCCESS;
}

EFI_UNIT_TEST(tpl) = {
	.name = "task priority levels",
	.phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
	.setup = setup,
	.execute = execute,
	.teardown = teardown,
};
Commit	Line	Data
1835f6ea HS	1	/*
	2	* efi_selftest_events
	3	*
	4	* Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
	5	*
	6	* SPDX-License-Identifier: GPL-2.0+
	7	*
	8	* This unit test uses timer events to check the handling of
	9	* task priority levels.
	10	*/
	11
	12	#include <efi_selftest.h>
	13
	14	static struct efi_event *event_notify;
	15	static struct efi_event *event_wait;
e67e7249	16	static unsigned int notification_count;
1835f6ea HS	17	static struct efi_boot_services *boottime;
	18
	19	/*
e67e7249	20	* Notification function, increments the notification count.
1835f6ea HS	21	*
1835f6ea HS	22	* @event notified event
e67e7249	23	* @context pointer to the notification count
1835f6ea HS	24	*/
	25	static void EFIAPI notify(struct efi_event event, void context)
	26	{
e67e7249 HS	27	unsigned int *count = context;
e67e7249 HS	28
7f8ec5b6 HS	29	if (count)
7f8ec5b6 HS	30	++*count;
1835f6ea HS	31	}
	32
	33	/*
	34	* Setup unit test.
	35	*
	36	* Create two timer events.
	37	* One with EVT_NOTIFY_SIGNAL, the other with EVT_NOTIFY_WAIT.
	38	*
	39	* @handle: handle of the loaded image
	40	* @systable: system table
e67e7249	41	* @return: EFI_ST_SUCCESS for success
1835f6ea HS	42	*/
	43	static int setup(const efi_handle_t handle,
	44	const struct efi_system_table *systable)
	45	{
	46	efi_status_t ret;
	47
	48	boottime = systable->boottime;
	49
	50	ret = boottime->create_event(EVT_TIMER \| EVT_NOTIFY_SIGNAL,
e67e7249 HS	51	TPL_CALLBACK, notify,
e67e7249 HS	52	(void *)&notification_count,
1835f6ea HS	53	&event_notify);
	54	if (ret != EFI_SUCCESS) {
	55	efi_st_error("could not create event\n");
e67e7249	56	return EFI_ST_FAILURE;
1835f6ea HS	57	}
	58	ret = boottime->create_event(EVT_TIMER \| EVT_NOTIFY_WAIT,
	59	TPL_HIGH_LEVEL, notify, NULL, &event_wait);
	60	if (ret != EFI_SUCCESS) {
	61	efi_st_error("could not create event\n");
e67e7249	62	return EFI_ST_FAILURE;
1835f6ea	63	}
e67e7249	64	return EFI_ST_SUCCESS;
1835f6ea HS	65	}
	66
	67	/*
	68	* Tear down unit test.
	69	*
	70	* Close the events created in setup.
e67e7249 HS	71	*
e67e7249 HS	72	* @return: EFI_ST_SUCCESS for success
1835f6ea HS	73	*/
	74	static int teardown(void)
	75	{
	76	efi_status_t ret;
	77
	78	if (event_notify) {
	79	ret = boottime->close_event(event_notify);
	80	event_notify = NULL;
	81	if (ret != EFI_SUCCESS) {
	82	efi_st_error("could not close event\n");
e67e7249	83	return EFI_ST_FAILURE;
1835f6ea HS	84	}
	85	}
	86	if (event_wait) {
	87	ret = boottime->close_event(event_wait);
	88	event_wait = NULL;
	89	if (ret != EFI_SUCCESS) {
	90	efi_st_error("could not close event\n");
e67e7249	91	return EFI_ST_FAILURE;
1835f6ea HS	92	}
	93	}
	94	boottime->restore_tpl(TPL_APPLICATION);
e67e7249	95	return EFI_ST_SUCCESS;
1835f6ea HS	96	}
	97
	98	/*
	99	* Execute unit test.
	100	*
	101	* Run a 10 ms periodic timer and check that it is called 10 times
	102	* while waiting for 100 ms single shot timer.
	103	*
	104	* Raise the TPL level to the level of the 10 ms timer and observe
	105	* that the notification function is not called again.
	106	*
	107	* Lower the TPL level and check that the queued notification
	108	* function is called.
e67e7249 HS	109	*
e67e7249 HS	110	* @return: EFI_ST_SUCCESS for success
1835f6ea HS	111	*/
	112	static int execute(void)
	113	{
f5a2a938	114	efi_uintn_t index;
1835f6ea	115	efi_status_t ret;
152cade3	116	efi_uintn_t old_tpl;
1835f6ea HS	117
1835f6ea HS	118	/* Set 10 ms timer */
e67e7249	119	notification_count = 0;
1835f6ea HS	120	ret = boottime->set_timer(event_notify, EFI_TIMER_PERIODIC, 100000);
	121	if (ret != EFI_SUCCESS) {
	122	efi_st_error("Could not set timer\n");
e67e7249	123	return EFI_ST_FAILURE;
1835f6ea HS	124	}
	125	/* Set 100 ms timer */
	126	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000000);
	127	if (ret != EFI_SUCCESS) {
	128	efi_st_error("Could not set timer\n");
e67e7249	129	return EFI_ST_FAILURE;
1835f6ea HS	130	}
	131	index = 5;
	132	ret = boottime->wait_for_event(1, &event_wait, &index);
	133	if (ret != EFI_SUCCESS) {
	134	efi_st_error("Could not wait for event\n");
e67e7249	135	return EFI_ST_FAILURE;
1835f6ea HS	136	}
	137	ret = boottime->check_event(event_wait);
	138	if (ret != EFI_NOT_READY) {
	139	efi_st_error("Signaled state was not cleared.\n");
	140	efi_st_printf("ret = %u\n", (unsigned int)ret);
e67e7249	141	return EFI_ST_FAILURE;
1835f6ea HS	142	}
	143	if (index != 0) {
	144	efi_st_error("WaitForEvent returned wrong index\n");
e67e7249	145	return EFI_ST_FAILURE;
1835f6ea	146	}
e67e7249 HS	147	efi_st_printf("Notification count with TPL level TPL_APPLICATION: %u\n",
	148	notification_count);
	149	if (notification_count < 8 \|\| notification_count > 12) {
1835f6ea	150	efi_st_error("Incorrect timing of events\n");
e67e7249	151	return EFI_ST_FAILURE;
1835f6ea HS	152	}
	153	ret = boottime->set_timer(event_notify, EFI_TIMER_STOP, 0);
	154	if (index != 0) {
	155	efi_st_error("Could not cancel timer\n");
e67e7249	156	return EFI_ST_FAILURE;
1835f6ea HS	157	}
	158	/* Raise TPL level */
	159	old_tpl = boottime->raise_tpl(TPL_CALLBACK);
	160	if (old_tpl != TPL_APPLICATION) {
	161	efi_st_error("Initial TPL level was not TPL_APPLICATION");
e67e7249	162	return EFI_ST_FAILURE;
1835f6ea HS	163	}
1835f6ea HS	164	/* Set 10 ms timer */
e67e7249	165	notification_count = 0;
1835f6ea HS	166	ret = boottime->set_timer(event_notify, EFI_TIMER_PERIODIC, 100000);
	167	if (index != 0) {
	168	efi_st_error("Could not set timer\n");
e67e7249	169	return EFI_ST_FAILURE;
1835f6ea HS	170	}
	171	/* Set 100 ms timer */
	172	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000000);
	173	if (ret != EFI_SUCCESS) {
	174	efi_st_error("Could not set timer\n");
e67e7249	175	return EFI_ST_FAILURE;
1835f6ea HS	176	}
	177	do {
	178	ret = boottime->check_event(event_wait);
	179	} while (ret == EFI_NOT_READY);
	180	if (ret != EFI_SUCCESS) {
	181	efi_st_error("Could not check event\n");
e67e7249	182	return EFI_ST_FAILURE;
1835f6ea	183	}
e67e7249 HS	184	efi_st_printf("Notification count with TPL level TPL_CALLBACK: %u\n",
	185	notification_count);
	186	if (notification_count != 0) {
1835f6ea	187	efi_st_error("Suppressed timer fired\n");
e67e7249	188	return EFI_ST_FAILURE;
1835f6ea HS	189	}
	190	/* Set 1 ms timer */
	191	ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000);
	192	if (ret != EFI_SUCCESS) {
	193	efi_st_error("Could not set timer\n");
e67e7249	194	return EFI_ST_FAILURE;
1835f6ea HS	195	}
	196	/* Restore the old TPL level */
	197	boottime->restore_tpl(TPL_APPLICATION);
	198	ret = boottime->wait_for_event(1, &event_wait, &index);
	199	if (ret != EFI_SUCCESS) {
	200	efi_st_error("Could not wait for event\n");
e67e7249	201	return EFI_ST_FAILURE;
1835f6ea	202	}
e67e7249 HS	203	efi_st_printf("Notification count with TPL level TPL_APPLICATION: %u\n",
	204	notification_count);
	205	if (notification_count < 1) {
1835f6ea	206	efi_st_error("Queued timer event did not fire\n");
e67e7249	207	return EFI_ST_FAILURE;
1835f6ea HS	208	}
1835f6ea HS	209	ret = boottime->set_timer(event_wait, EFI_TIMER_STOP, 0);
abe99463	210	if (ret != EFI_SUCCESS) {
1835f6ea	211	efi_st_error("Could not cancel timer\n");
e67e7249	212	return EFI_ST_FAILURE;
1835f6ea HS	213	}
1835f6ea HS	214
e67e7249	215	return EFI_ST_SUCCESS;
1835f6ea HS	216	}
	217
	218	EFI_UNIT_TEST(tpl) = {
	219	.name = "task priority levels",
	220	.phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
	221	.setup = setup,
	222	.execute = execute,
	223	.teardown = teardown,
	224	};