[people/ms/u-boot.git] / board / liebherr / lwmon5 / kbd.c

/*
 * (C) Copyright 2007
 * Stefan Roese, DENX Software Engineering, sr@denx.de.
 *
 * (C) Copyright 2001, 2002
 * DENX Software Engineering
 * Wolfgang Denk, wd@denx.de
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

/* define DEBUG for debugging output (obviously ;-)) */
#if 0
#define DEBUG
#endif

#include <common.h>
#include <i2c.h>
#include <command.h>
#include <console.h>
#include <post.h>
#include <serial.h>
#include <malloc.h>

#include <linux/types.h>
#include <linux/string.h>	/* for strdup */

DECLARE_GLOBAL_DATA_PTR;

static void kbd_init (void);
static int compare_magic (uchar *kbd_data, uchar *str);

/*--------------------- Local macros and constants --------------------*/
#define	_NOT_USED_	0xFFFFFFFF

/*------------------------- dspic io expander -----------------------*/
#define DSPIC_PON_STATUS_REG	0x80A
#define DSPIC_PON_INV_STATUS_REG 0x80C
#define DSPIC_PON_KEY_REG	0x810
/*------------------------- Keyboard controller -----------------------*/
/* command codes */
#define	KEYBD_CMD_READ_KEYS	0x01
#define KEYBD_CMD_READ_VERSION	0x02
#define KEYBD_CMD_READ_STATUS	0x03
#define KEYBD_CMD_RESET_ERRORS	0x10

/* status codes */
#define KEYBD_STATUS_MASK	0x3F
#define	KEYBD_STATUS_H_RESET	0x20
#define KEYBD_STATUS_BROWNOUT	0x10
#define KEYBD_STATUS_WD_RESET	0x08
#define KEYBD_STATUS_OVERLOAD	0x04
#define KEYBD_STATUS_ILLEGAL_WR	0x02
#define KEYBD_STATUS_ILLEGAL_RD	0x01

/* Number of bytes returned from Keyboard Controller */
#define KEYBD_VERSIONLEN	2	/* version information */

/*
 * This is different from the "old" lwmon dsPIC kbd controller
 * implementation. Now the controller still answers with 9 bytes,
 * but the last 3 bytes are always "0x06 0x07 0x08". So we just
 * set the length to compare to 6 instead of 9.
 */
#define	KEYBD_DATALEN		6	/* normal key scan data */

/* maximum number of "magic" key codes that can be assigned */

static uchar kbd_addr = CONFIG_SYS_I2C_KEYBD_ADDR;
static uchar dspic_addr = CONFIG_SYS_I2C_DSPIC_IO_ADDR;

static uchar *key_match (uchar *);

#define	KEYBD_SET_DEBUGMODE	'#'	/* Magic key to enable debug output */

/***********************************************************************
F* Function:     int board_postclk_init (void) P*A*Z*
 *
P* Parameters:   none
P*
P* Returnvalue:  int
P*                - 0 is always returned.
 *
Z* Intention:    This function is the board_postclk_init() method implementation
Z*               for the lwmon board.
 *
 ***********************************************************************/
int board_postclk_init (void)
{
	kbd_init();

	return (0);
}

static void kbd_init (void)
{
	uchar kbd_data[KEYBD_DATALEN];
	uchar tmp_data[KEYBD_DATALEN];
	uchar val, errcd;
	int i;

	i2c_set_bus_num(0);

	gd->arch.kbd_status = 0;

	/* Forced by PIC. Delays <= 175us loose */
	udelay(1000);

	/* Read initial keyboard error code */
	val = KEYBD_CMD_READ_STATUS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, &errcd, 1);
	/* clear unused bits */
	errcd &= KEYBD_STATUS_MASK;
	/* clear "irrelevant" bits. Recommended by Martin Rajek, LWN */
	errcd &= ~(KEYBD_STATUS_H_RESET|KEYBD_STATUS_BROWNOUT);
	if (errcd) {
		gd->arch.kbd_status |= errcd << 8;
	}
	/* Reset error code and verify */
	val = KEYBD_CMD_RESET_ERRORS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	udelay(1000);	/* delay NEEDED by keyboard PIC !!! */

	val = KEYBD_CMD_READ_STATUS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, &val, 1);

	val &= KEYBD_STATUS_MASK;	/* clear unused bits */
	if (val) {			/* permanent error, report it */
		gd->arch.kbd_status |= val;
		return;
	}

	/*
	 * Read current keyboard state.
	 *
	 * After the error reset it may take some time before the
	 * keyboard PIC picks up a valid keyboard scan - the total
	 * scan time is approx. 1.6 ms (information by Martin Rajek,
	 * 28 Sep 2002). We read a couple of times for the keyboard
	 * to stabilize, using a big enough delay.
	 * 10 times should be enough. If the data is still changing,
	 * we use what we get :-(
	 */

	memset (tmp_data, 0xFF, KEYBD_DATALEN);	/* impossible value */
	for (i=0; i<10; ++i) {
		val = KEYBD_CMD_READ_KEYS;
		i2c_write (kbd_addr, 0, 0, &val, 1);
		i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);

		if (memcmp(kbd_data, tmp_data, KEYBD_DATALEN) == 0) {
			/* consistent state, done */
			break;
		}
		/* remeber last state, delay, and retry */
		memcpy (tmp_data, kbd_data, KEYBD_DATALEN);
		udelay (5000);
	}
}


/* Read a register from the dsPIC. */
int _dspic_read(ushort reg, ushort *data)
{
	uchar buf[sizeof(*data)];
	int rval;

	if (i2c_read(dspic_addr, reg, 2, buf, 2))
		return -1;

	rval = i2c_read(dspic_addr, reg, sizeof(reg), buf, sizeof(*data));
	*data = (buf[0] << 8) | buf[1];

	return rval;
}


/***********************************************************************
F* Function:     int misc_init_r (void) P*A*Z*
 *
P* Parameters:   none
P*
P* Returnvalue:  int
P*                - 0 is always returned, even in the case of a keyboard
P*                    error.
 *
Z* Intention:    This function is the misc_init_r() method implementation
Z*               for the lwmon board.
Z*               The keyboard controller is initialized and the result
Z*               of a read copied to the environment variable "keybd".
Z*               If KEYBD_SET_DEBUGMODE is defined, a check is made for
Z*               this key, and if found display to the LCD will be enabled.
Z*               The keys in "keybd" are checked against the magic
Z*               keycommands defined in the environment.
Z*               See also key_match().
 *
D* Design:       wd@denx.de
C* Coding:       wd@denx.de
V* Verification: dzu@denx.de
 ***********************************************************************/
int misc_init_r_kbd (void)
{
	uchar kbd_data[KEYBD_DATALEN];
	char keybd_env[2 * KEYBD_DATALEN + 1];
	uchar kbd_init_status = gd->arch.kbd_status >> 8;
	uchar kbd_status = gd->arch.kbd_status;
	uchar val;
	ushort data, inv_data;
	char *str;
	int i;

	if (kbd_init_status) {
		printf ("KEYBD: Error %02X\n", kbd_init_status);
	}
	if (kbd_status) {		/* permanent error, report it */
		printf ("*** Keyboard error code %02X ***\n", kbd_status);
		sprintf (keybd_env, "%02X", kbd_status);
		setenv ("keybd", keybd_env);
		return 0;
	}

	/*
	 * Now we know that we have a working  keyboard,  so  disable
	 * all output to the LCD except when a key press is detected.
	 */

	if ((console_assign (stdout, "serial") < 0) ||
		(console_assign (stderr, "serial") < 0)) {
		printf ("Can't assign serial port as output device\n");
	}

	/* Read Version */
	val = KEYBD_CMD_READ_VERSION;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_VERSIONLEN);
	printf ("KEYBD: Version %d.%d\n", kbd_data[0], kbd_data[1]);

	/* Read current keyboard state */
	val = KEYBD_CMD_READ_KEYS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);

	/* read out start key from bse01 received via can */
	_dspic_read(DSPIC_PON_STATUS_REG, &data);
	/* check highbyte from status register */
	if (data > 0xFF) {
		_dspic_read(DSPIC_PON_INV_STATUS_REG, &inv_data);

		/* check inverse data */
		if ((data+inv_data) == 0xFFFF) {
			/* don't overwrite local key */
			if (kbd_data[1] == 0) {
				/* read key value */
				_dspic_read(DSPIC_PON_KEY_REG, &data);
				str = (char *)&data;
				/* swap bytes */
				kbd_data[1] = str[1];
				kbd_data[2] = str[0];
				printf("CAN received startkey: 0x%X\n", data);
			}
		}
	}

	for (i = 0; i < KEYBD_DATALEN; ++i) {
		sprintf (keybd_env + i + i, "%02X", kbd_data[i]);
	}

	setenv ("keybd", keybd_env);

	str = strdup ((char *)key_match (kbd_data));	/* decode keys */
#ifdef KEYBD_SET_DEBUGMODE
	if (kbd_data[0] == KEYBD_SET_DEBUGMODE) {	/* set debug mode */
		if ((console_assign (stdout, "lcd") < 0) ||
			(console_assign (stderr, "lcd") < 0)) {
			printf ("Can't assign LCD display as output device\n");
		}
	}
#endif /* KEYBD_SET_DEBUGMODE */
#ifdef CONFIG_PREBOOT	/* automatically configure "preboot" command on key match */
	setenv ("preboot", str);	/* set or delete definition */
#endif /* CONFIG_PREBOOT */
	if (str != NULL) {
		free (str);
	}
	return (0);
}

#ifdef CONFIG_PREBOOT

static uchar kbd_magic_prefix[] = "key_magic";
static uchar kbd_command_prefix[] = "key_cmd";

static int compare_magic (uchar *kbd_data, uchar *str)
{
	uchar compare[KEYBD_DATALEN-1];
	char *nxt;
	int i;

	/* Don't include modifier byte */
	memcpy (compare, kbd_data+1, KEYBD_DATALEN-1);

	for (; str != NULL; str = (*nxt) ? (uchar *)(nxt+1) : (uchar *)nxt) {
		uchar c;
		int k;

		c = (uchar) simple_strtoul ((char *)str, (char **) (&nxt), 16);

		if (str == (uchar *)nxt) {	/* invalid character */
			break;
		}

		/*
		 * Check if this key matches the input.
		 * Set matches to zero, so they match only once
		 * and we can find duplicates or extra keys
		 */
		for (k = 0; k < sizeof(compare); ++k) {
			if (compare[k] == '\0')	/* only non-zero entries */
				continue;
			if (c == compare[k]) {	/* found matching key */
				compare[k] = '\0';
				break;
			}
		}
		if (k == sizeof(compare)) {
			return -1;		/* unmatched key */
		}
	}

	/*
	 * A full match leaves no keys in the `compare' array,
	 */
	for (i = 0; i < sizeof(compare); ++i) {
		if (compare[i])
		{
			return -1;
		}
	}

	return 0;
}

/***********************************************************************
F* Function:     static uchar *key_match (uchar *kbd_data) P*A*Z*
 *
P* Parameters:   uchar *kbd_data
P*                - The keys to match against our magic definitions
P*
P* Returnvalue:  uchar *
P*                - != NULL: Pointer to the corresponding command(s)
P*                     NULL: No magic is about to happen
 *
Z* Intention:    Check if pressed key(s) match magic sequence,
Z*               and return the command string associated with that key(s).
Z*
Z*               If no key press was decoded, NULL is returned.
Z*
Z*               Note: the first character of the argument will be
Z*                     overwritten with the "magic charcter code" of the
Z*                     decoded key(s), or '\0'.
Z*
Z*               Note: the string points to static environment data
Z*                     and must be saved before you call any function that
Z*                     modifies the environment.
 *
D* Design:       wd@denx.de
C* Coding:       wd@denx.de
V* Verification: dzu@denx.de
 ***********************************************************************/
static uchar *key_match (uchar *kbd_data)
{
	char magic[sizeof (kbd_magic_prefix) + 1];
	uchar *suffix;
	char *kbd_magic_keys;

	/*
	 * The following string defines the characters that can pe appended
	 * to "key_magic" to form the names of environment variables that
	 * hold "magic" key codes, i. e. such key codes that can cause
	 * pre-boot actions. If the string is empty (""), then only
	 * "key_magic" is checked (old behaviour); the string "125" causes
	 * checks for "key_magic1", "key_magic2" and "key_magic5", etc.
	 */
	if ((kbd_magic_keys = getenv ("magic_keys")) == NULL)
		kbd_magic_keys = "";

	/* loop over all magic keys;
	 * use '\0' suffix in case of empty string
	 */
	for (suffix=(uchar *)kbd_magic_keys; *suffix || suffix==(uchar *)kbd_magic_keys; ++suffix) {
		sprintf (magic, "%s%c", kbd_magic_prefix, *suffix);
		debug ("### Check magic \"%s\"\n", magic);
		if (compare_magic(kbd_data, (uchar *)getenv(magic)) == 0) {
			char cmd_name[sizeof (kbd_command_prefix) + 1];
			char *cmd;

			sprintf (cmd_name, "%s%c", kbd_command_prefix, *suffix);

			cmd = getenv (cmd_name);
			debug ("### Set PREBOOT to $(%s): \"%s\"\n",
					cmd_name, cmd ? cmd : "<<NULL>>");
			*kbd_data = *suffix;
			return ((uchar *)cmd);
		}
	}
	debug ("### Delete PREBOOT\n");
	*kbd_data = '\0';
	return (NULL);
}
#endif /* CONFIG_PREBOOT */

/***********************************************************************
F* Function:     int do_kbd (cmd_tbl_t *cmdtp, int flag,
F*                           int argc, char * const argv[]) P*A*Z*
 *
P* Parameters:   cmd_tbl_t *cmdtp
P*                - Pointer to our command table entry
P*               int flag
P*                - If the CMD_FLAG_REPEAT bit is set, then this call is
P*                  a repetition
P*               int argc
P*                - Argument count
P*               char * const argv[]
P*                - Array of the actual arguments
P*
P* Returnvalue:  int
P*                - 0 is always returned.
 *
Z* Intention:    Implement the "kbd" command.
Z*               The keyboard status is read.  The result is printed on
Z*               the console and written into the "keybd" environment
Z*               variable.
 *
D* Design:       wd@denx.de
C* Coding:       wd@denx.de
V* Verification: dzu@denx.de
 ***********************************************************************/
int do_kbd (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	uchar kbd_data[KEYBD_DATALEN];
	char keybd_env[2 * KEYBD_DATALEN + 1];
	uchar val;
	int i;

#if 0 /* Done in kbd_init */
	i2c_init (CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
#endif

	/* Read keys */
	val = KEYBD_CMD_READ_KEYS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);

	puts ("Keys:");
	for (i = 0; i < KEYBD_DATALEN; ++i) {
		sprintf (keybd_env + i + i, "%02X", kbd_data[i]);
		printf (" %02x", kbd_data[i]);
	}
	putc ('\n');
	setenv ("keybd", keybd_env);
	return 0;
}

U_BOOT_CMD(
	kbd,	1,	1,	do_kbd,
	"read keyboard status",
	""
);

/*----------------------------- Utilities -----------------------------*/

#ifdef CONFIG_POST
/*
 * Returns 1 if keys pressed to start the power-on long-running tests
 * Called from board_init_f().
 */
int post_hotkeys_pressed(void)
{
	uchar kbd_data[KEYBD_DATALEN];
	uchar val;

	/* Read keys */
	val = KEYBD_CMD_READ_KEYS;
	i2c_write (kbd_addr, 0, 0, &val, 1);
	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);

	return (compare_magic(kbd_data, (uchar *)CONFIG_POST_KEY_MAGIC) == 0);
}
#endif
Commit	Line	Data
04386f65 SR	1	/*
	2	* (C) Copyright 2007
	3	* Stefan Roese, DENX Software Engineering, sr@denx.de.
	4	*
	5	* (C) Copyright 2001, 2002
	6	* DENX Software Engineering
	7	* Wolfgang Denk, wd@denx.de
	8	*
	9	* SPDX-License-Identifier: GPL-2.0+
	10	*/
	11
	12	/* define DEBUG for debugging output (obviously ;-)) */
	13	#if 0
	14	#define DEBUG
	15	#endif
	16
	17	#include <common.h>
	18	#include <i2c.h>
	19	#include <command.h>
24b852a7	20	#include <console.h>
04386f65 SR	21	#include <post.h>
	22	#include <serial.h>
	23	#include <malloc.h>
	24
	25	#include <linux/types.h>
	26	#include <linux/string.h> /* for strdup */
	27
	28	DECLARE_GLOBAL_DATA_PTR;
	29
	30	static void kbd_init (void);
	31	static int compare_magic (uchar kbd_data, uchar str);
	32
	33	/--------------------- Local macros and constants --------------------/
	34	#define _NOT_USED_ 0xFFFFFFFF
	35
	36	/------------------------- dspic io expander -----------------------/
	37	#define DSPIC_PON_STATUS_REG 0x80A
	38	#define DSPIC_PON_INV_STATUS_REG 0x80C
	39	#define DSPIC_PON_KEY_REG 0x810
	40	/------------------------- Keyboard controller -----------------------/
	41	/* command codes */
	42	#define KEYBD_CMD_READ_KEYS 0x01
	43	#define KEYBD_CMD_READ_VERSION 0x02
	44	#define KEYBD_CMD_READ_STATUS 0x03
	45	#define KEYBD_CMD_RESET_ERRORS 0x10
	46
	47	/* status codes */
	48	#define KEYBD_STATUS_MASK 0x3F
	49	#define KEYBD_STATUS_H_RESET 0x20
	50	#define KEYBD_STATUS_BROWNOUT 0x10
	51	#define KEYBD_STATUS_WD_RESET 0x08
	52	#define KEYBD_STATUS_OVERLOAD 0x04
	53	#define KEYBD_STATUS_ILLEGAL_WR 0x02
	54	#define KEYBD_STATUS_ILLEGAL_RD 0x01
	55
	56	/* Number of bytes returned from Keyboard Controller */
	57	#define KEYBD_VERSIONLEN 2 /* version information */
	58
	59	/*
	60	* This is different from the "old" lwmon dsPIC kbd controller
	61	* implementation. Now the controller still answers with 9 bytes,
	62	* but the last 3 bytes are always "0x06 0x07 0x08". So we just
	63	* set the length to compare to 6 instead of 9.
	64	*/
	65	#define KEYBD_DATALEN 6 /* normal key scan data */
	66
	67	/* maximum number of "magic" key codes that can be assigned */
	68
	69	static uchar kbd_addr = CONFIG_SYS_I2C_KEYBD_ADDR;
	70	static uchar dspic_addr = CONFIG_SYS_I2C_DSPIC_IO_ADDR;
	71
	72	static uchar key_match (uchar );
	73
	74	#define KEYBD_SET_DEBUGMODE '#' /* Magic key to enable debug output */
	75
	76	/***********************************************************************
	77	F* Function: int board_postclk_init (void) PAZ*
	78	*
	79	P* Parameters: none
	80	P*
	81	P* Returnvalue: int
	82	P* - 0 is always returned.
	83	*
	84	Z* Intention: This function is the board_postclk_init() method implementation
85	Z* for the lwmon board.
86	*
87	***********************************************************************/
88	int board_postclk_init (void)
89	{
90	kbd_init();
91
92	return (0);
93	}
94
95	static void kbd_init (void)
96	{
97	uchar kbd_data[KEYBD_DATALEN];
98	uchar tmp_data[KEYBD_DATALEN];
99	uchar val, errcd;
100	int i;
101
102	i2c_set_bus_num(0);
103
104	gd->arch.kbd_status = 0;
105
106	/* Forced by PIC. Delays <= 175us loose */
107	udelay(1000);
108
109	/* Read initial keyboard error code */
110	val = KEYBD_CMD_READ_STATUS;
111	i2c_write (kbd_addr, 0, 0, &val, 1);
112	i2c_read (kbd_addr, 0, 0, &errcd, 1);
113	/* clear unused bits */
114	errcd &= KEYBD_STATUS_MASK;
115	/* clear "irrelevant" bits. Recommended by Martin Rajek, LWN */
116	errcd &= ~(KEYBD_STATUS_H_RESET\|KEYBD_STATUS_BROWNOUT);
117	if (errcd) {
118	gd->arch.kbd_status \|= errcd << 8;
119	}
120	/* Reset error code and verify */
121	val = KEYBD_CMD_RESET_ERRORS;
122	i2c_write (kbd_addr, 0, 0, &val, 1);
123	udelay(1000); /* delay NEEDED by keyboard PIC !!! */
124
125	val = KEYBD_CMD_READ_STATUS;
126	i2c_write (kbd_addr, 0, 0, &val, 1);
127	i2c_read (kbd_addr, 0, 0, &val, 1);
128
129	val &= KEYBD_STATUS_MASK; /* clear unused bits */
130	if (val) { /* permanent error, report it */
131	gd->arch.kbd_status \|= val;
132	return;
133	}
134
135	/*
136	* Read current keyboard state.
137	*
138	* After the error reset it may take some time before the
139	* keyboard PIC picks up a valid keyboard scan - the total
140	* scan time is approx. 1.6 ms (information by Martin Rajek,
141	* 28 Sep 2002). We read a couple of times for the keyboard
142	* to stabilize, using a big enough delay.
143	* 10 times should be enough. If the data is still changing,
144	* we use what we get :-(
145	*/
146
147	memset (tmp_data, 0xFF, KEYBD_DATALEN); /* impossible value */
148	for (i=0; i<10; ++i) {
149	val = KEYBD_CMD_READ_KEYS;
150	i2c_write (kbd_addr, 0, 0, &val, 1);
151	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);
152
153	if (memcmp(kbd_data, tmp_data, KEYBD_DATALEN) == 0) {
154	/* consistent state, done */
155	break;
156	}
157	/* remeber last state, delay, and retry */
158	memcpy (tmp_data, kbd_data, KEYBD_DATALEN);
159	udelay (5000);
160	}
161	}
162
163
164	/* Read a register from the dsPIC. */
165	int _dspic_read(ushort reg, ushort *data)
166	{
167	uchar buf[sizeof(*data)];
168	int rval;
169
170	if (i2c_read(dspic_addr, reg, 2, buf, 2))
171	return -1;
172
173	rval = i2c_read(dspic_addr, reg, sizeof(reg), buf, sizeof(*data));
174	*data = (buf[0] << 8) \| buf[1];
175
176	return rval;
177	}
178
179
180	/***********************************************************************
181	F* Function: int misc_init_r (void) PAZ*
182	*
183	P* Parameters: none
184	P*
185	P* Returnvalue: int
186	P* - 0 is always returned, even in the case of a keyboard
187	P* error.
188	*
189	Z* Intention: This function is the misc_init_r() method implementation
190	Z* for the lwmon board.
191	Z* The keyboard controller is initialized and the result
192	Z* of a read copied to the environment variable "keybd".
193	Z* If KEYBD_SET_DEBUGMODE is defined, a check is made for
194	Z* this key, and if found display to the LCD will be enabled.
195	Z* The keys in "keybd" are checked against the magic
196	Z* keycommands defined in the environment.
197	Z* See also key_match().
198	*
199	D* Design: wd@denx.de
200	C* Coding: wd@denx.de
201	V* Verification: dzu@denx.de
202	***********************************************************************/
203	int misc_init_r_kbd (void)
204	{
205	uchar kbd_data[KEYBD_DATALEN];
206	char keybd_env[2 * KEYBD_DATALEN + 1];
207	uchar kbd_init_status = gd->arch.kbd_status >> 8;
208	uchar kbd_status = gd->arch.kbd_status;
209	uchar val;
210	ushort data, inv_data;
211	char *str;
212	int i;
213
214	if (kbd_init_status) {
215	printf ("KEYBD: Error %02X\n", kbd_init_status);
216	}
217	if (kbd_status) { /* permanent error, report it */
218	printf ("* Keyboard error code %02X *\n", kbd_status);
219	sprintf (keybd_env, "%02X", kbd_status);
220	setenv ("keybd", keybd_env);
221	return 0;
222	}
223
224	/*
225	* Now we know that we have a working keyboard, so disable
226	* all output to the LCD except when a key press is detected.
227	*/
228
229	if ((console_assign (stdout, "serial") < 0) \|\|
230	(console_assign (stderr, "serial") < 0)) {
231	printf ("Can't assign serial port as output device\n");
232	}
233
234	/* Read Version */
235	val = KEYBD_CMD_READ_VERSION;
236	i2c_write (kbd_addr, 0, 0, &val, 1);
237	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_VERSIONLEN);
238	printf ("KEYBD: Version %d.%d\n", kbd_data[0], kbd_data[1]);
239
240	/* Read current keyboard state */
241	val = KEYBD_CMD_READ_KEYS;
242	i2c_write (kbd_addr, 0, 0, &val, 1);
243	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);
244
245	/* read out start key from bse01 received via can */
246	_dspic_read(DSPIC_PON_STATUS_REG, &data);
247	/* check highbyte from status register */
248	if (data > 0xFF) {
249	_dspic_read(DSPIC_PON_INV_STATUS_REG, &inv_data);
250
251	/* check inverse data */
252	if ((data+inv_data) == 0xFFFF) {
253	/* don't overwrite local key */
254	if (kbd_data[1] == 0) {
255	/* read key value */
256	_dspic_read(DSPIC_PON_KEY_REG, &data);
257	str = (char *)&data;
258	/* swap bytes */
259	kbd_data[1] = str[1];
260	kbd_data[2] = str[0];
261	printf("CAN received startkey: 0x%X\n", data);
262	}
263	}
264	}
265
266	for (i = 0; i < KEYBD_DATALEN; ++i) {
267	sprintf (keybd_env + i + i, "%02X", kbd_data[i]);
268	}
269
270	setenv ("keybd", keybd_env);
271
272	str = strdup ((char )key_match (kbd_data)); / decode keys */
273	#ifdef KEYBD_SET_DEBUGMODE
274	if (kbd_data[0] == KEYBD_SET_DEBUGMODE) { /* set debug mode */
275	if ((console_assign (stdout, "lcd") < 0) \|\|
276	(console_assign (stderr, "lcd") < 0)) {
277	printf ("Can't assign LCD display as output device\n");
278	}
279	}
280	#endif /* KEYBD_SET_DEBUGMODE */
281	#ifdef CONFIG_PREBOOT /* automatically configure "preboot" command on key match */
282	setenv ("preboot", str); /* set or delete definition */
283	#endif /* CONFIG_PREBOOT */
284	if (str != NULL) {
285	free (str);
286	}
287	return (0);
288	}
289
290	#ifdef CONFIG_PREBOOT
291
292	static uchar kbd_magic_prefix[] = "key_magic";
293	static uchar kbd_command_prefix[] = "key_cmd";
294
295	static int compare_magic (uchar kbd_data, uchar str)
296	{
297	uchar compare[KEYBD_DATALEN-1];
298	char *nxt;
299	int i;
300
301	/* Don't include modifier byte */
302	memcpy (compare, kbd_data+1, KEYBD_DATALEN-1);
303
304	for (; str != NULL; str = (nxt) ? (uchar )(nxt+1) : (uchar *)nxt) {
305	uchar c;
306	int k;
307
308	c = (uchar) simple_strtoul ((char )str, (char *) (&nxt), 16);
309
310	if (str == (uchar )nxt) { / invalid character */
311	break;
312	}
313
314	/*
315	* Check if this key matches the input.
316	* Set matches to zero, so they match only once
317	* and we can find duplicates or extra keys
318	*/
319	for (k = 0; k < sizeof(compare); ++k) {
320	if (compare[k] == '\0') /* only non-zero entries */
321	continue;
322	if (c == compare[k]) { /* found matching key */
323	compare[k] = '\0';
324	break;
325	}
326	}
327	if (k == sizeof(compare)) {
328	return -1; /* unmatched key */
329	}
330	}
331
332	/*
333	* A full match leaves no keys in the `compare' array,
334	*/
335	for (i = 0; i < sizeof(compare); ++i) {
336	if (compare[i])
337	{
338	return -1;
339	}
340	}
341
342	return 0;
343	}
344
345	/***********************************************************************
346	F* Function: static uchar key_match (uchar kbd_data) PAZ*
347	*
348	P* Parameters: uchar *kbd_data
349	P* - The keys to match against our magic definitions
350	P*
351	P* Returnvalue: uchar *
352	P* - != NULL: Pointer to the corresponding command(s)
353	P* NULL: No magic is about to happen
354	*
355	Z* Intention: Check if pressed key(s) match magic sequence,
356	Z* and return the command string associated with that key(s).
357	Z*
358	Z* If no key press was decoded, NULL is returned.
359	Z*
360	Z* Note: the first character of the argument will be
361	Z* overwritten with the "magic charcter code" of the
362	Z* decoded key(s), or '\0'.
363	Z*
364	Z* Note: the string points to static environment data
365	Z* and must be saved before you call any function that
366	Z* modifies the environment.
367	*
368	D* Design: wd@denx.de
369	C* Coding: wd@denx.de
370	V* Verification: dzu@denx.de
371	***********************************************************************/
372	static uchar key_match (uchar kbd_data)
373	{
374	char magic[sizeof (kbd_magic_prefix) + 1];
375	uchar *suffix;
376	char *kbd_magic_keys;
377
378	/*
379	* The following string defines the characters that can pe appended
380	* to "key_magic" to form the names of environment variables that
381	* hold "magic" key codes, i. e. such key codes that can cause
382	* pre-boot actions. If the string is empty (""), then only
383	* "key_magic" is checked (old behaviour); the string "125" causes
384	* checks for "key_magic1", "key_magic2" and "key_magic5", etc.
385	*/
386	if ((kbd_magic_keys = getenv ("magic_keys")) == NULL)
387	kbd_magic_keys = "";
388
389	/* loop over all magic keys;
390	* use '\0' suffix in case of empty string
391	*/
392	for (suffix=(uchar )kbd_magic_keys; suffix \|\| suffix==(uchar *)kbd_magic_keys; ++suffix) {
393	sprintf (magic, "%s%c", kbd_magic_prefix, *suffix);
394	debug ("### Check magic \"%s\"\n", magic);
395	if (compare_magic(kbd_data, (uchar *)getenv(magic)) == 0) {
396	char cmd_name[sizeof (kbd_command_prefix) + 1];
397	char *cmd;
398
399	sprintf (cmd_name, "%s%c", kbd_command_prefix, *suffix);
400
401	cmd = getenv (cmd_name);
402	debug ("### Set PREBOOT to $(%s): \"%s\"\n",
403	cmd_name, cmd ? cmd : "<<NULL>>");
404	kbd_data = suffix;
405	return ((uchar *)cmd);
406	}
407	}
408	debug ("### Delete PREBOOT\n");
409	*kbd_data = '\0';
410	return (NULL);
411	}
412	#endif /* CONFIG_PREBOOT */
413
414	/***********************************************************************
415	F* Function: int do_kbd (cmd_tbl_t *cmdtp, int flag,
416	F* int argc, char * const argv[]) PAZ*
417	*
418	P* Parameters: cmd_tbl_t *cmdtp
419	P* - Pointer to our command table entry
420	P* int flag
421	P* - If the CMD_FLAG_REPEAT bit is set, then this call is
422	P* a repetition
423	P* int argc
424	P* - Argument count
425	P* char * const argv[]
426	P* - Array of the actual arguments
427	P*
428	P* Returnvalue: int
429	P* - 0 is always returned.
430	*
431	Z* Intention: Implement the "kbd" command.
432	Z* The keyboard status is read. The result is printed on
433	Z* the console and written into the "keybd" environment
434	Z* variable.
435	*
436	D* Design: wd@denx.de
437	C* Coding: wd@denx.de
438	V* Verification: dzu@denx.de
439	***********************************************************************/
440	int do_kbd (cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
441	{
442	uchar kbd_data[KEYBD_DATALEN];
443	char keybd_env[2 * KEYBD_DATALEN + 1];
444	uchar val;
445	int i;
446
447	#if 0 /* Done in kbd_init */
448	i2c_init (CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
449	#endif
450
451	/* Read keys */
452	val = KEYBD_CMD_READ_KEYS;
453	i2c_write (kbd_addr, 0, 0, &val, 1);
454	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);
455
456	puts ("Keys:");
457	for (i = 0; i < KEYBD_DATALEN; ++i) {
458	sprintf (keybd_env + i + i, "%02X", kbd_data[i]);
459	printf (" %02x", kbd_data[i]);
460	}
461	putc ('\n');
462	setenv ("keybd", keybd_env);
463	return 0;
464	}
465
466	U_BOOT_CMD(
467	kbd, 1, 1, do_kbd,
468	"read keyboard status",
469	""
470	);
471
472	/----------------------------- Utilities -----------------------------/
473
474	#ifdef CONFIG_POST
475	/*
476	* Returns 1 if keys pressed to start the power-on long-running tests
477	* Called from board_init_f().
478	*/
479	int post_hotkeys_pressed(void)
480	{
481	uchar kbd_data[KEYBD_DATALEN];
482	uchar val;
483
484	/* Read keys */
485	val = KEYBD_CMD_READ_KEYS;
486	i2c_write (kbd_addr, 0, 0, &val, 1);
487	i2c_read (kbd_addr, 0, 0, kbd_data, KEYBD_DATALEN);
488
489	return (compare_magic(kbd_data, (uchar *)CONFIG_POST_KEY_MAGIC) == 0);
490	}
491	#endif