Blame view

common/cli_readline.c 12.5 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  // SPDX-License-Identifier: GPL-2.0+
6493ccc7c   Simon Glass   Split out simple ...
2
3
4
5
6
7
8
  /*
   * (C) Copyright 2000
   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *
   * Add to readline cmdline-editing by
   * (C) Copyright 2005
   * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
6493ccc7c   Simon Glass   Split out simple ...
9
10
11
   */
  
  #include <common.h>
0098e179e   Simon Glass   Move bootretry co...
12
  #include <bootretry.h>
6493ccc7c   Simon Glass   Split out simple ...
13
14
15
16
17
18
19
  #include <cli.h>
  #include <watchdog.h>
  
  DECLARE_GLOBAL_DATA_PTR;
  
  static const char erase_seq[] = "\b \b";	/* erase sequence */
  static const char   tab_seq[] = "        ";	/* used to expand TABs */
6493ccc7c   Simon Glass   Split out simple ...
20
  char console_buffer[CONFIG_SYS_CBSIZE + 1];	/* console I/O buffer	*/
6493ccc7c   Simon Glass   Split out simple ...
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
  static char *delete_char (char *buffer, char *p, int *colp, int *np, int plen)
  {
  	char *s;
  
  	if (*np == 0)
  		return p;
  
  	if (*(--p) == '\t') {		/* will retype the whole line */
  		while (*colp > plen) {
  			puts(erase_seq);
  			(*colp)--;
  		}
  		for (s = buffer; s < p; ++s) {
  			if (*s == '\t') {
  				puts(tab_seq + ((*colp) & 07));
  				*colp += 8 - ((*colp) & 07);
  			} else {
  				++(*colp);
  				putc(*s);
  			}
  		}
  	} else {
  		puts(erase_seq);
  		(*colp)--;
  	}
  	(*np)--;
  
  	return p;
  }
  
  #ifdef CONFIG_CMDLINE_EDITING
  
  /*
   * cmdline-editing related codes from vivi.
   * Author: Janghoon Lyu <nandy@mizi.com>
   */
  
  #define putnstr(str, n)	printf("%.*s", (int)n, str)
  
  #define CTL_CH(c)		((c) - 'a' + 1)
  #define CTL_BACKSPACE		('\b')
  #define DEL			((char)255)
  #define DEL7			((char)127)
  #define CREAD_HIST_CHAR		('!')
  
  #define getcmd_putch(ch)	putc(ch)
  #define getcmd_getch()		getc()
  #define getcmd_cbeep()		getcmd_putch('\a')
  
  #define HIST_MAX		20
  #define HIST_SIZE		CONFIG_SYS_CBSIZE
  
  static int hist_max;
  static int hist_add_idx;
  static int hist_cur = -1;
  static unsigned hist_num;
  
  static char *hist_list[HIST_MAX];
  static char hist_lines[HIST_MAX][HIST_SIZE + 1];	/* Save room for NULL */
  
  #define add_idx_minus_one() ((hist_add_idx == 0) ? hist_max : hist_add_idx-1)
  
  static void hist_init(void)
  {
  	int i;
  
  	hist_max = 0;
  	hist_add_idx = 0;
  	hist_cur = -1;
  	hist_num = 0;
  
  	for (i = 0; i < HIST_MAX; i++) {
  		hist_list[i] = hist_lines[i];
  		hist_list[i][0] = '\0';
  	}
  }
  
  static void cread_add_to_hist(char *line)
  {
  	strcpy(hist_list[hist_add_idx], line);
  
  	if (++hist_add_idx >= HIST_MAX)
  		hist_add_idx = 0;
  
  	if (hist_add_idx > hist_max)
  		hist_max = hist_add_idx;
  
  	hist_num++;
  }
  
  static char *hist_prev(void)
  {
  	char *ret;
  	int old_cur;
  
  	if (hist_cur < 0)
  		return NULL;
  
  	old_cur = hist_cur;
  	if (--hist_cur < 0)
  		hist_cur = hist_max;
  
  	if (hist_cur == hist_add_idx) {
  		hist_cur = old_cur;
  		ret = NULL;
  	} else {
  		ret = hist_list[hist_cur];
  	}
  
  	return ret;
  }
  
  static char *hist_next(void)
  {
  	char *ret;
  
  	if (hist_cur < 0)
  		return NULL;
  
  	if (hist_cur == hist_add_idx)
  		return NULL;
  
  	if (++hist_cur > hist_max)
  		hist_cur = 0;
  
  	if (hist_cur == hist_add_idx)
  		ret = "";
  	else
  		ret = hist_list[hist_cur];
  
  	return ret;
  }
  
  #ifndef CONFIG_CMDLINE_EDITING
  static void cread_print_hist_list(void)
  {
  	int i;
  	unsigned long n;
  
  	n = hist_num - hist_max;
  
  	i = hist_add_idx + 1;
  	while (1) {
  		if (i > hist_max)
  			i = 0;
  		if (i == hist_add_idx)
  			break;
  		printf("%s
  ", hist_list[i]);
  		n++;
  		i++;
  	}
  }
  #endif /* CONFIG_CMDLINE_EDITING */
  
  #define BEGINNING_OF_LINE() {			\
  	while (num) {				\
  		getcmd_putch(CTL_BACKSPACE);	\
  		num--;				\
  	}					\
  }
  
  #define ERASE_TO_EOL() {				\
  	if (num < eol_num) {				\
  		printf("%*s", (int)(eol_num - num), ""); \
  		do {					\
  			getcmd_putch(CTL_BACKSPACE);	\
  		} while (--eol_num > num);		\
  	}						\
  }
  
  #define REFRESH_TO_EOL() {			\
  	if (num < eol_num) {			\
  		wlen = eol_num - num;		\
  		putnstr(buf + num, wlen);	\
  		num = eol_num;			\
  	}					\
  }
  
  static void cread_add_char(char ichar, int insert, unsigned long *num,
  	       unsigned long *eol_num, char *buf, unsigned long len)
  {
  	unsigned long wlen;
  
  	/* room ??? */
  	if (insert || *num == *eol_num) {
  		if (*eol_num > len - 1) {
  			getcmd_cbeep();
  			return;
  		}
  		(*eol_num)++;
  	}
  
  	if (insert) {
  		wlen = *eol_num - *num;
  		if (wlen > 1)
  			memmove(&buf[*num+1], &buf[*num], wlen-1);
  
  		buf[*num] = ichar;
  		putnstr(buf + *num, wlen);
  		(*num)++;
  		while (--wlen)
  			getcmd_putch(CTL_BACKSPACE);
  	} else {
  		/* echo the character */
  		wlen = 1;
  		buf[*num] = ichar;
  		putnstr(buf + *num, wlen);
  		(*num)++;
  	}
  }
  
  static void cread_add_str(char *str, int strsize, int insert,
  			  unsigned long *num, unsigned long *eol_num,
  			  char *buf, unsigned long len)
  {
  	while (strsize--) {
  		cread_add_char(*str, insert, num, eol_num, buf, len);
  		str++;
  	}
  }
  
  static int cread_line(const char *const prompt, char *buf, unsigned int *len,
  		int timeout)
  {
  	unsigned long num = 0;
  	unsigned long eol_num = 0;
  	unsigned long wlen;
  	char ichar;
  	int insert = 1;
  	int esc_len = 0;
  	char esc_save[8];
  	int init_len = strlen(buf);
  	int first = 1;
  
  	if (init_len)
  		cread_add_str(buf, init_len, 1, &num, &eol_num, buf, *len);
  
  	while (1) {
0098e179e   Simon Glass   Move bootretry co...
260
261
  		if (bootretry_tstc_timeout())
  			return -2;	/* timed out */
6493ccc7c   Simon Glass   Split out simple ...
262
263
264
265
266
267
268
269
270
271
272
273
  		if (first && timeout) {
  			uint64_t etime = endtick(timeout);
  
  			while (!tstc()) {	/* while no incoming data */
  				if (get_ticks() >= etime)
  					return -2;	/* timed out */
  				WATCHDOG_RESET();
  			}
  			first = 0;
  		}
  
  		ichar = getcmd_getch();
555e378ca   Patrick Delaunay   cli: handle getch...
274
275
276
  		/* ichar=0x0 when error occurs in U-Boot getc */
  		if (!ichar)
  			continue;
6493ccc7c   Simon Glass   Split out simple ...
277
278
279
280
281
282
283
284
285
286
287
  		if ((ichar == '
  ') || (ichar == '\r')) {
  			putc('
  ');
  			break;
  		}
  
  		/*
  		 * handle standard linux xterm esc sequences for arrow key, etc.
  		 */
  		if (esc_len != 0) {
fc18e9b3d   James Byrne   common: cli_readl...
288
  			enum { ESC_REJECT, ESC_SAVE, ESC_CONVERTED } act = ESC_REJECT;
6493ccc7c   Simon Glass   Split out simple ...
289
  			if (esc_len == 1) {
fc18e9b3d   James Byrne   common: cli_readl...
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
  				if (ichar == '[' || ichar == 'O')
  					act = ESC_SAVE;
  			} else if (esc_len == 2) {
  				switch (ichar) {
  				case 'D':	/* <- key */
  					ichar = CTL_CH('b');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^B handler */
  				case 'C':	/* -> key */
  					ichar = CTL_CH('f');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^F handler */
  				case 'H':	/* Home key */
  					ichar = CTL_CH('a');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^A handler */
  				case 'F':	/* End key */
  					ichar = CTL_CH('e');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^E handler */
  				case 'A':	/* up arrow */
  					ichar = CTL_CH('p');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^P handler */
  				case 'B':	/* down arrow */
  					ichar = CTL_CH('n');
  					act = ESC_CONVERTED;
  					break;	/* pass off to ^N handler */
  				case '1':
  				case '3':
  				case '4':
  				case '7':
  				case '8':
  					if (esc_save[1] == '[') {
  						/* see if next character is ~ */
  						act = ESC_SAVE;
  					}
  					break;
  				}
  			} else if (esc_len == 3) {
  				if (ichar == '~') {
  					switch (esc_save[2]) {
  					case '3':	/* Delete key */
  						ichar = CTL_CH('d');
  						act = ESC_CONVERTED;
  						break;	/* pass to ^D handler */
  					case '1':	/* Home key */
  					case '7':
  						ichar = CTL_CH('a');
  						act = ESC_CONVERTED;
  						break;	/* pass to ^A handler */
  					case '4':	/* End key */
  					case '8':
  						ichar = CTL_CH('e');
  						act = ESC_CONVERTED;
  						break;	/* pass to ^E handler */
  					}
6493ccc7c   Simon Glass   Split out simple ...
347
  				}
6493ccc7c   Simon Glass   Split out simple ...
348
  			}
fc18e9b3d   James Byrne   common: cli_readl...
349
350
351
352
353
  			switch (act) {
  			case ESC_SAVE:
  				esc_save[esc_len++] = ichar;
  				continue;
  			case ESC_REJECT:
6493ccc7c   Simon Glass   Split out simple ...
354
355
356
357
358
  				esc_save[esc_len++] = ichar;
  				cread_add_str(esc_save, esc_len, insert,
  					      &num, &eol_num, buf, *len);
  				esc_len = 0;
  				continue;
fc18e9b3d   James Byrne   common: cli_readl...
359
360
361
  			case ESC_CONVERTED:
  				esc_len = 0;
  				break;
6493ccc7c   Simon Glass   Split out simple ...
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
  			}
  		}
  
  		switch (ichar) {
  		case 0x1b:
  			if (esc_len == 0) {
  				esc_save[esc_len] = ichar;
  				esc_len = 1;
  			} else {
  				puts("impossible condition #876
  ");
  				esc_len = 0;
  			}
  			break;
  
  		case CTL_CH('a'):
  			BEGINNING_OF_LINE();
  			break;
  		case CTL_CH('c'):	/* ^C - break */
  			*buf = '\0';	/* discard input */
  			return -1;
  		case CTL_CH('f'):
  			if (num < eol_num) {
  				getcmd_putch(buf[num]);
  				num++;
  			}
  			break;
  		case CTL_CH('b'):
  			if (num) {
  				getcmd_putch(CTL_BACKSPACE);
  				num--;
  			}
  			break;
  		case CTL_CH('d'):
  			if (num < eol_num) {
  				wlen = eol_num - num - 1;
  				if (wlen) {
  					memmove(&buf[num], &buf[num+1], wlen);
  					putnstr(buf + num, wlen);
  				}
  
  				getcmd_putch(' ');
  				do {
  					getcmd_putch(CTL_BACKSPACE);
  				} while (wlen--);
  				eol_num--;
  			}
  			break;
  		case CTL_CH('k'):
  			ERASE_TO_EOL();
  			break;
  		case CTL_CH('e'):
  			REFRESH_TO_EOL();
  			break;
  		case CTL_CH('o'):
  			insert = !insert;
  			break;
  		case CTL_CH('x'):
  		case CTL_CH('u'):
  			BEGINNING_OF_LINE();
  			ERASE_TO_EOL();
  			break;
  		case DEL:
  		case DEL7:
  		case 8:
  			if (num) {
  				wlen = eol_num - num;
  				num--;
  				memmove(&buf[num], &buf[num+1], wlen);
  				getcmd_putch(CTL_BACKSPACE);
  				putnstr(buf + num, wlen);
  				getcmd_putch(' ');
  				do {
  					getcmd_putch(CTL_BACKSPACE);
  				} while (wlen--);
  				eol_num--;
  			}
  			break;
  		case CTL_CH('p'):
  		case CTL_CH('n'):
  		{
  			char *hline;
  
  			esc_len = 0;
  
  			if (ichar == CTL_CH('p'))
  				hline = hist_prev();
  			else
  				hline = hist_next();
  
  			if (!hline) {
  				getcmd_cbeep();
  				continue;
  			}
  
  			/* nuke the current line */
  			/* first, go home */
  			BEGINNING_OF_LINE();
  
  			/* erase to end of line */
  			ERASE_TO_EOL();
  
  			/* copy new line into place and display */
  			strcpy(buf, hline);
  			eol_num = strlen(buf);
  			REFRESH_TO_EOL();
  			continue;
  		}
  #ifdef CONFIG_AUTO_COMPLETE
  		case '\t': {
  			int num2, col;
  
  			/* do not autocomplete when in the middle */
  			if (num < eol_num) {
  				getcmd_cbeep();
  				break;
  			}
  
  			buf[num] = '\0';
  			col = strlen(prompt) + eol_num;
  			num2 = num;
  			if (cmd_auto_complete(prompt, buf, &num2, &col)) {
  				col = num2 - num;
  				num += col;
  				eol_num += col;
  			}
  			break;
  		}
  #endif
  		default:
  			cread_add_char(ichar, insert, &num, &eol_num, buf,
  				       *len);
  			break;
  		}
  	}
  	*len = eol_num;
  	buf[eol_num] = '\0';	/* lose the newline */
  
  	if (buf[0] && buf[0] != CREAD_HIST_CHAR)
  		cread_add_to_hist(buf);
  	hist_cur = hist_add_idx;
  
  	return 0;
  }
  
  #endif /* CONFIG_CMDLINE_EDITING */
  
  /****************************************************************************/
e1bf824df   Simon Glass   Add cli_ prefix t...
510
  int cli_readline(const char *const prompt)
6493ccc7c   Simon Glass   Split out simple ...
511
512
513
514
515
516
  {
  	/*
  	 * If console_buffer isn't 0-length the user will be prompted to modify
  	 * it instead of entering it from scratch as desired.
  	 */
  	console_buffer[0] = '\0';
e1bf824df   Simon Glass   Add cli_ prefix t...
517
  	return cli_readline_into_buffer(prompt, console_buffer, 0);
6493ccc7c   Simon Glass   Split out simple ...
518
  }
e1bf824df   Simon Glass   Add cli_ prefix t...
519
520
  int cli_readline_into_buffer(const char *const prompt, char *buffer,
  			     int timeout)
6493ccc7c   Simon Glass   Split out simple ...
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
  {
  	char *p = buffer;
  #ifdef CONFIG_CMDLINE_EDITING
  	unsigned int len = CONFIG_SYS_CBSIZE;
  	int rc;
  	static int initted;
  
  	/*
  	 * History uses a global array which is not
  	 * writable until after relocation to RAM.
  	 * Revert to non-history version if still
  	 * running from flash.
  	 */
  	if (gd->flags & GD_FLG_RELOC) {
  		if (!initted) {
  			hist_init();
  			initted = 1;
  		}
  
  		if (prompt)
  			puts(prompt);
  
  		rc = cread_line(prompt, p, &len, timeout);
  		return rc < 0 ? rc : len;
  
  	} else {
  #endif	/* CONFIG_CMDLINE_EDITING */
  	char *p_buf = p;
  	int	n = 0;				/* buffer index		*/
  	int	plen = 0;			/* prompt length	*/
  	int	col;				/* output column cnt	*/
  	char	c;
  
  	/* print prompt */
  	if (prompt) {
  		plen = strlen(prompt);
  		puts(prompt);
  	}
  	col = plen;
  
  	for (;;) {
0098e179e   Simon Glass   Move bootretry co...
562
563
  		if (bootretry_tstc_timeout())
  			return -2;	/* timed out */
6493ccc7c   Simon Glass   Split out simple ...
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  		WATCHDOG_RESET();	/* Trigger watchdog, if needed */
  
  #ifdef CONFIG_SHOW_ACTIVITY
  		while (!tstc()) {
  			show_activity(0);
  			WATCHDOG_RESET();
  		}
  #endif
  		c = getc();
  
  		/*
  		 * Special character handling
  		 */
  		switch (c) {
  		case '\r':			/* Enter		*/
  		case '
  ':
  			*p = '\0';
  			puts("\r
  ");
  			return p - p_buf;
  
  		case '\0':			/* nul			*/
  			continue;
  
  		case 0x03:			/* ^C - break		*/
  			p_buf[0] = '\0';	/* discard input */
  			return -1;
  
  		case 0x15:			/* ^U - erase line	*/
  			while (col > plen) {
  				puts(erase_seq);
  				--col;
  			}
  			p = p_buf;
  			n = 0;
  			continue;
  
  		case 0x17:			/* ^W - erase word	*/
  			p = delete_char(p_buf, p, &col, &n, plen);
  			while ((n > 0) && (*p != ' '))
  				p = delete_char(p_buf, p, &col, &n, plen);
  			continue;
  
  		case 0x08:			/* ^H  - backspace	*/
  		case 0x7F:			/* DEL - backspace	*/
  			p = delete_char(p_buf, p, &col, &n, plen);
  			continue;
  
  		default:
  			/*
  			 * Must be a normal character then
  			 */
  			if (n < CONFIG_SYS_CBSIZE-2) {
  				if (c == '\t') {	/* expand TABs */
  #ifdef CONFIG_AUTO_COMPLETE
  					/*
  					 * if auto completion triggered just
  					 * continue
  					 */
  					*p = '\0';
  					if (cmd_auto_complete(prompt,
  							      console_buffer,
  							      &n, &col)) {
  						p = p_buf + n;	/* reset */
  						continue;
  					}
  #endif
  					puts(tab_seq + (col & 07));
  					col += 8 - (col & 07);
  				} else {
80402f34f   Heiko Schocher   spl, common, seri...
635
  					char __maybe_unused buf[2];
6493ccc7c   Simon Glass   Split out simple ...
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
  
  					/*
  					 * Echo input using puts() to force an
  					 * LCD flush if we are using an LCD
  					 */
  					++col;
  					buf[0] = c;
  					buf[1] = '\0';
  					puts(buf);
  				}
  				*p++ = c;
  				++n;
  			} else {			/* Buffer full */
  				putc('\a');
  			}
  		}
  	}
  #ifdef CONFIG_CMDLINE_EDITING
  	}
  #endif
  }