iPXE
prompt.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2011 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 /** @file
27  *
28  * Prompt for keypress
29  *
30  */
31 
32 #include <errno.h>
33 #include <stdio.h>
34 #include <ipxe/console.h>
35 #include <usr/prompt.h>
36 
37 /**
38  * Prompt for keypress
39  *
40  * @v text Prompt string
41  * @v timeout Timeout period, in ticks (0=indefinite)
42  * @v key Key to wait for (0=any key)
43  * @ret rc Return status code
44  *
45  * Returns success if the specified key was pressed within the
46  * specified timeout period.
47  */
48 int prompt ( const char *text, unsigned long timeout, int key ) {
49  int key_pressed;
50 
51  /* Display prompt */
52  printf ( "%s", text );
53 
54  /* Wait for key */
55  key_pressed = getkey ( timeout );
56 
57  /* Clear the prompt line */
58  while ( *(text++) )
59  printf ( "\b \b" );
60 
61  /* Check for timeout */
62  if ( key_pressed < 0 )
63  return -ETIMEDOUT;
64 
65  /* Check for correct key pressed */
66  if ( key && ( key_pressed != key ) )
67  return -ECANCELED;
68 
69  return 0;
70 }
int getkey(unsigned long timeout)
Get single keypress.
Definition: getkey.c:71
int printf(const char *fmt,...)
Write a formatted string to the console.
Definition: vsprintf.c:464
Error codes.
Prompt for keypress.
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
#define ECANCELED
Operation canceled.
Definition: errno.h:343
User interaction.
int prompt(const char *text, unsigned long timeout, int key)
Prompt for keypress.
Definition: prompt.c:48
void timeout(int)
#define ETIMEDOUT
Connection timed out.
Definition: errno.h:669
union @376 key
Sense key.
Definition: scsi.h:18