[thirdparty/u-boot.git] / lib / tiny-printf.c

// SPDX-License-Identifier: LGPL-2.1+
/*
 * Tiny printf version for SPL
 *
 * Copied from:
 * http://www.sparetimelabs.com/printfrevisited/printfrevisited.php
 *
 * Copyright (C) 2004,2008  Kustaa Nyholm
 */

#include <common.h>
#include <stdarg.h>
#include <serial.h>
#include <linux/ctype.h>

struct printf_info {
	char *bf;	/* Digit buffer */
	char zs;	/* non-zero if a digit has been written */
	char *outstr;	/* Next output position for sprintf() */

	/* Output a character */
	void (*putc)(struct printf_info *info, char ch);
};

static void out(struct printf_info *info, char c)
{
	*info->bf++ = c;
}

static void out_dgt(struct printf_info *info, char dgt)
{
	out(info, dgt + (dgt < 10 ? '0' : 'a' - 10));
	info->zs = 1;
}

static void div_out(struct printf_info *info, unsigned long *num,
		    unsigned long div)
{
	unsigned char dgt = 0;

	while (*num >= div) {
		*num -= div;
		dgt++;
	}

	if (info->zs || dgt > 0)
		out_dgt(info, dgt);
}

#ifdef CONFIG_SPL_NET_SUPPORT
static void string(struct printf_info *info, char *s)
{
	char ch;

	while ((ch = *s++))
		out(info, ch);
}

static const char hex_asc[] = "0123456789abcdef";
#define hex_asc_lo(x)	hex_asc[((x) & 0x0f)]
#define hex_asc_hi(x)	hex_asc[((x) & 0xf0) >> 4]

static inline char *pack_hex_byte(char *buf, u8 byte)
{
	*buf++ = hex_asc_hi(byte);
	*buf++ = hex_asc_lo(byte);
	return buf;
}

static void mac_address_string(struct printf_info *info, u8 *addr,
				bool separator)
{
	/* (6 * 2 hex digits), 5 colons and trailing zero */
	char mac_addr[6 * 3];
	char *p = mac_addr;
	int i;

	for (i = 0; i < 6; i++) {
		p = pack_hex_byte(p, addr[i]);
		if (separator && i != 5)
			*p++ = ':';
	}
	*p = '\0';

	string(info, mac_addr);
}

static char *put_dec_trunc(char *buf, unsigned int q)
{
	unsigned int d3, d2, d1, d0;
	d1 = (q >> 4) & 0xf;
	d2 = (q >> 8) & 0xf;
	d3 = (q >> 12);

	d0 = 6 * (d3 + d2 + d1) + (q & 0xf);
	q = (d0 * 0xcd) >> 11;
	d0 = d0 - 10 * q;
	*buf++ = d0 + '0'; /* least significant digit */
	d1 = q + 9 * d3 + 5 * d2 + d1;
	if (d1 != 0) {
		q = (d1 * 0xcd) >> 11;
		d1 = d1 - 10 * q;
		*buf++ = d1 + '0'; /* next digit */

		d2 = q + 2 * d2;
		if ((d2 != 0) || (d3 != 0)) {
			q = (d2 * 0xd) >> 7;
			d2 = d2 - 10 * q;
			*buf++ = d2 + '0'; /* next digit */

			d3 = q + 4 * d3;
			if (d3 != 0) {
				q = (d3 * 0xcd) >> 11;
				d3 = d3 - 10 * q;
				*buf++ = d3 + '0';  /* next digit */
				if (q != 0)
					*buf++ = q + '0'; /* most sign. digit */
			}
		}
	}
	return buf;
}

static void ip4_addr_string(struct printf_info *info, u8 *addr)
{
	/* (4 * 3 decimal digits), 3 dots and trailing zero */
	char ip4_addr[4 * 4];
	char temp[3];	/* hold each IP quad in reverse order */
	char *p = ip4_addr;
	int i, digits;

	for (i = 0; i < 4; i++) {
		digits = put_dec_trunc(temp, addr[i]) - temp;
		/* reverse the digits in the quad */
		while (digits--)
			*p++ = temp[digits];
		if (i != 3)
			*p++ = '.';
	}
	*p = '\0';

	string(info, ip4_addr);
}
#endif

/*
 * Show a '%p' thing.  A kernel extension is that the '%p' is followed
 * by an extra set of characters that are extended format
 * specifiers.
 *
 * Right now we handle:
 *
 * - 'M' For a 6-byte MAC address, it prints the address in the
 *       usual colon-separated hex notation.
 * - 'm' Same as above except there is no colon-separator.
 * - 'I4'for IPv4 addresses printed in the usual way (dot-separated
 *       decimal).
 */

static void pointer(struct printf_info *info, const char *fmt, void *ptr)
{
#ifdef DEBUG
	unsigned long num = (uintptr_t)ptr;
	unsigned long div;
#endif

	switch (*fmt) {
#ifdef DEBUG
	case 'a':

		switch (fmt[1]) {
		case 'p':
		default:
			num = *(phys_addr_t *)ptr;
			break;
		}
		break;
#endif
#ifdef CONFIG_SPL_NET_SUPPORT
	case 'm':
		return mac_address_string(info, ptr, false);
	case 'M':
		return mac_address_string(info, ptr, true);
	case 'I':
		if (fmt[1] == '4')
			return ip4_addr_string(info, ptr);
#endif
	default:
		break;
	}
#ifdef DEBUG
	div = 1UL << (sizeof(long) * 8 - 4);
	for (; div; div /= 0x10)
		div_out(info, &num, div);
#endif
}

static int _vprintf(struct printf_info *info, const char *fmt, va_list va)
{
	char ch;
	char *p;
	unsigned long num;
	char buf[12];
	unsigned long div;

	while ((ch = *(fmt++))) {
		if (ch != '%') {
			info->putc(info, ch);
		} else {
			bool lz = false;
			int width = 0;
			bool islong = false;

			ch = *(fmt++);
			if (ch == '-')
				ch = *(fmt++);

			if (ch == '0') {
				ch = *(fmt++);
				lz = 1;
			}

			if (ch >= '0' && ch <= '9') {
				width = 0;
				while (ch >= '0' && ch <= '9') {
					width = (width * 10) + ch - '0';
					ch = *fmt++;
				}
			}
			if (ch == 'l') {
				ch = *(fmt++);
				islong = true;
			}

			info->bf = buf;
			p = info->bf;
			info->zs = 0;

			switch (ch) {
			case '\0':
				goto abort;
			case 'u':
			case 'd':
				div = 1000000000;
				if (islong) {
					num = va_arg(va, unsigned long);
					if (sizeof(long) > 4)
						div *= div * 10;
				} else {
					num = va_arg(va, unsigned int);
				}

				if (ch == 'd') {
					if (islong && (long)num < 0) {
						num = -(long)num;
						out(info, '-');
					} else if (!islong && (int)num < 0) {
						num = -(int)num;
						out(info, '-');
					}
				}
				if (!num) {
					out_dgt(info, 0);
				} else {
					for (; div; div /= 10)
						div_out(info, &num, div);
				}
				break;
			case 'x':
				if (islong) {
					num = va_arg(va, unsigned long);
					div = 1UL << (sizeof(long) * 8 - 4);
				} else {
					num = va_arg(va, unsigned int);
					div = 0x10000000;
				}
				if (!num) {
					out_dgt(info, 0);
				} else {
					for (; div; div /= 0x10)
						div_out(info, &num, div);
				}
				break;
			case 'c':
				out(info, (char)(va_arg(va, int)));
				break;
			case 's':
				p = va_arg(va, char*);
				break;
			case 'p':
				pointer(info, fmt, va_arg(va, void *));
				while (isalnum(fmt[0]))
					fmt++;
				break;
			case '%':
				out(info, '%');
			default:
				break;
			}

			*info->bf = 0;
			info->bf = p;
			while (*info->bf++ && width > 0)
				width--;
			while (width-- > 0)
				info->putc(info, lz ? '0' : ' ');
			if (p) {
				while ((ch = *p++))
					info->putc(info, ch);
			}
		}
	}

abort:
	return 0;
}

#if CONFIG_IS_ENABLED(PRINTF)
static void putc_normal(struct printf_info *info, char ch)
{
	putc(ch);
}

int vprintf(const char *fmt, va_list va)
{
	struct printf_info info;

	info.putc = putc_normal;
	return _vprintf(&info, fmt, va);
}

int printf(const char *fmt, ...)
{
	struct printf_info info;

	va_list va;
	int ret;

	info.putc = putc_normal;
	va_start(va, fmt);
	ret = _vprintf(&info, fmt, va);
	va_end(va);

	return ret;
}
#endif

static void putc_outstr(struct printf_info *info, char ch)
{
	*info->outstr++ = ch;
}

int sprintf(char *buf, const char *fmt, ...)
{
	struct printf_info info;
	va_list va;
	int ret;

	va_start(va, fmt);
	info.outstr = buf;
	info.putc = putc_outstr;
	ret = _vprintf(&info, fmt, va);
	va_end(va);
	*info.outstr = '\0';

	return ret;
}

/* Note that size is ignored */
int snprintf(char *buf, size_t size, const char *fmt, ...)
{
	struct printf_info info;
	va_list va;
	int ret;

	va_start(va, fmt);
	info.outstr = buf;
	info.putc = putc_outstr;
	ret = _vprintf(&info, fmt, va);
	va_end(va);
	*info.outstr = '\0';

	return ret;
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: LGPL-2.1+
7d9cde10 SR	2	/*
	3	* Tiny printf version for SPL
	4	*
	5	* Copied from:
	6	* http://www.sparetimelabs.com/printfrevisited/printfrevisited.php
	7	*
	8	* Copyright (C) 2004,2008 Kustaa Nyholm
7d9cde10 SR	9	*/
	10
	11	#include <common.h>
	12	#include <stdarg.h>
	13	#include <serial.h>
cdce1f76	14	#include <linux/ctype.h>
7d9cde10	15
45313e83 SG	16	struct printf_info {
	17	char bf; / Digit buffer */
	18	char zs; /* non-zero if a digit has been written */
	19	char outstr; / Next output position for sprintf() */
7d9cde10	20
45313e83 SG	21	/* Output a character */
	22	void (putc)(struct printf_info info, char ch);
	23	};
5c411d88	24
45313e83	25	static void out(struct printf_info *info, char c)
7d9cde10	26	{
45313e83	27	*info->bf++ = c;
7d9cde10 SR	28	}
7d9cde10 SR	29
45313e83 SG	30	static void out_dgt(struct printf_info *info, char dgt)
	31	{
	32	out(info, dgt + (dgt < 10 ? '0' : 'a' - 10));
	33	info->zs = 1;
	34	}
	35
a28e1d98 AP	36	static void div_out(struct printf_info info, unsigned long num,
a28e1d98 AP	37	unsigned long div)
7d9cde10 SR	38	{
	39	unsigned char dgt = 0;
	40
a5ecdd08 SR	41	while (*num >= div) {
a5ecdd08 SR	42	*num -= div;
7d9cde10 SR	43	dgt++;
	44	}
	45
45313e83 SG	46	if (info->zs \|\| dgt > 0)
45313e83 SG	47	out_dgt(info, dgt);
7d9cde10 SR	48	}
7d9cde10 SR	49
cdce1f76 V	50	#ifdef CONFIG_SPL_NET_SUPPORT
	51	static void string(struct printf_info info, char s)
	52	{
	53	char ch;
	54
	55	while ((ch = *s++))
	56	out(info, ch);
	57	}
	58
	59	static const char hex_asc[] = "0123456789abcdef";
	60	#define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
	61	#define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
	62
	63	static inline char pack_hex_byte(char buf, u8 byte)
	64	{
	65	*buf++ = hex_asc_hi(byte);
	66	*buf++ = hex_asc_lo(byte);
	67	return buf;
	68	}
	69
	70	static void mac_address_string(struct printf_info info, u8 addr,
	71	bool separator)
	72	{
	73	/* (6 * 2 hex digits), 5 colons and trailing zero */
	74	char mac_addr[6 * 3];
	75	char *p = mac_addr;
	76	int i;
	77
	78	for (i = 0; i < 6; i++) {
	79	p = pack_hex_byte(p, addr[i]);
	80	if (separator && i != 5)
	81	*p++ = ':';
	82	}
	83	*p = '\0';
	84
	85	string(info, mac_addr);
	86	}
	87
	88	static char put_dec_trunc(char buf, unsigned int q)
	89	{
	90	unsigned int d3, d2, d1, d0;
	91	d1 = (q >> 4) & 0xf;
	92	d2 = (q >> 8) & 0xf;
	93	d3 = (q >> 12);
	94
	95	d0 = 6 * (d3 + d2 + d1) + (q & 0xf);
	96	q = (d0 * 0xcd) >> 11;
	97	d0 = d0 - 10 * q;
	98	buf++ = d0 + '0'; / least significant digit */
	99	d1 = q + 9 * d3 + 5 * d2 + d1;
	100	if (d1 != 0) {
	101	q = (d1 * 0xcd) >> 11;
	102	d1 = d1 - 10 * q;
	103	buf++ = d1 + '0'; / next digit */
	104
	105	d2 = q + 2 * d2;
	106	if ((d2 != 0) \|\| (d3 != 0)) {
	107	q = (d2 * 0xd) >> 7;
	108	d2 = d2 - 10 * q;
	109	buf++ = d2 + '0'; / next digit */
	110
	111	d3 = q + 4 * d3;
	112	if (d3 != 0) {
	113	q = (d3 * 0xcd) >> 11;
114	d3 = d3 - 10 * q;
115	buf++ = d3 + '0'; / next digit */
116	if (q != 0)
117	buf++ = q + '0'; / most sign. digit */
118	}
119	}
120	}
121	return buf;
122	}
123
124	static void ip4_addr_string(struct printf_info info, u8 addr)
125	{
126	/* (4 * 3 decimal digits), 3 dots and trailing zero */
127	char ip4_addr[4 * 4];
128	char temp[3]; /* hold each IP quad in reverse order */
129	char *p = ip4_addr;
130	int i, digits;
131
132	for (i = 0; i < 4; i++) {
133	digits = put_dec_trunc(temp, addr[i]) - temp;
134	/* reverse the digits in the quad */
135	while (digits--)
136	*p++ = temp[digits];
137	if (i != 3)
138	*p++ = '.';
139	}
140	*p = '\0';
141
142	string(info, ip4_addr);
143	}
144	#endif
145
146	/*
147	* Show a '%p' thing. A kernel extension is that the '%p' is followed
148	* by an extra set of characters that are extended format
149	* specifiers.
150	*
151	* Right now we handle:
152	*
153	* - 'M' For a 6-byte MAC address, it prints the address in the
154	* usual colon-separated hex notation.
155	* - 'm' Same as above except there is no colon-separator.
156	* - 'I4'for IPv4 addresses printed in the usual way (dot-separated
157	* decimal).
158	*/
159
160	static void pointer(struct printf_info info, const char fmt, void *ptr)
161	{
162	#ifdef DEBUG
163	unsigned long num = (uintptr_t)ptr;
164	unsigned long div;
165	#endif
166
167	switch (*fmt) {
168	#ifdef DEBUG
169	case 'a':
170
171	switch (fmt[1]) {
172	case 'p':
173	default:
174	num = (phys_addr_t )ptr;
175	break;
176	}
177	break;
178	#endif
179	#ifdef CONFIG_SPL_NET_SUPPORT
180	case 'm':
181	return mac_address_string(info, ptr, false);
182	case 'M':
183	return mac_address_string(info, ptr, true);
184	case 'I':
185	if (fmt[1] == '4')
186	return ip4_addr_string(info, ptr);
187	#endif
188	default:
189	break;
190	}
191	#ifdef DEBUG
192	div = 1UL << (sizeof(long) * 8 - 4);
193	for (; div; div /= 0x10)
194	div_out(info, &num, div);
195	#endif
196	}
197
433cbfb3	198	static int _vprintf(struct printf_info info, const char fmt, va_list va)
7d9cde10	199	{
7d9cde10 SR	200	char ch;
7d9cde10 SR	201	char *p;
a28e1d98	202	unsigned long num;
a5ecdd08	203	char buf[12];
a28e1d98	204	unsigned long div;
7d9cde10	205
7d9cde10 SR	206	while ((ch = *(fmt++))) {
7d9cde10 SR	207	if (ch != '%') {
45313e83	208	info->putc(info, ch);
7d9cde10	209	} else {
1fb67608 SG	210	bool lz = false;
1fb67608 SG	211	int width = 0;
a28e1d98	212	bool islong = false;
7d9cde10 SR	213
7d9cde10 SR	214	ch = *(fmt++);
1c853629 AP	215	if (ch == '-')
	216	ch = *(fmt++);
	217
7d9cde10 SR	218	if (ch == '0') {
	219	ch = *(fmt++);
	220	lz = 1;
	221	}
	222
	223	if (ch >= '0' && ch <= '9') {
1fb67608	224	width = 0;
7d9cde10	225	while (ch >= '0' && ch <= '9') {
1fb67608	226	width = (width * 10) + ch - '0';
7d9cde10 SR	227	ch = *fmt++;
	228	}
	229	}
a28e1d98 AP	230	if (ch == 'l') {
	231	ch = *(fmt++);
	232	islong = true;
	233	}
	234
45313e83 SG	235	info->bf = buf;
	236	p = info->bf;
	237	info->zs = 0;
7d9cde10 SR	238
7d9cde10 SR	239	switch (ch) {
1fb67608	240	case '\0':
7d9cde10 SR	241	goto abort;
	242	case 'u':
	243	case 'd':
a28e1d98 AP	244	div = 1000000000;
	245	if (islong) {
	246	num = va_arg(va, unsigned long);
	247	if (sizeof(long) > 4)
	248	div = div 10;
	249	} else {
	250	num = va_arg(va, unsigned int);
	251	}
	252
	253	if (ch == 'd') {
	254	if (islong && (long)num < 0) {
	255	num = -(long)num;
	256	out(info, '-');
	257	} else if (!islong && (int)num < 0) {
	258	num = -(int)num;
	259	out(info, '-');
	260	}
7d9cde10	261	}
74b1320a	262	if (!num) {
45313e83	263	out_dgt(info, 0);
74b1320a	264	} else {
a28e1d98	265	for (; div; div /= 10)
45313e83	266	div_out(info, &num, div);
74b1320a	267	}
7d9cde10 SR	268	break;
7d9cde10 SR	269	case 'x':
a28e1d98 AP	270	if (islong) {
	271	num = va_arg(va, unsigned long);
	272	div = 1UL << (sizeof(long) * 8 - 4);
	273	} else {
	274	num = va_arg(va, unsigned int);
	275	div = 0x10000000;
	276	}
74b1320a	277	if (!num) {
45313e83	278	out_dgt(info, 0);
74b1320a	279	} else {
a28e1d98	280	for (; div; div /= 0x10)
45313e83	281	div_out(info, &num, div);
74b1320a	282	}
7d9cde10 SR	283	break;
7d9cde10 SR	284	case 'c':
45313e83	285	out(info, (char)(va_arg(va, int)));
7d9cde10 SR	286	break;
	287	case 's':
	288	p = va_arg(va, char*);
	289	break;
cdce1f76 V	290	case 'p':
	291	pointer(info, fmt, va_arg(va, void *));
	292	while (isalnum(fmt[0]))
	293	fmt++;
	294	break;
7d9cde10	295	case '%':
45313e83	296	out(info, '%');
7d9cde10 SR	297	default:
	298	break;
	299	}
	300
45313e83 SG	301	*info->bf = 0;
	302	info->bf = p;
	303	while (*info->bf++ && width > 0)
1fb67608 SG	304	width--;
1fb67608 SG	305	while (width-- > 0)
45313e83	306	info->putc(info, lz ? '0' : ' ');
8e31681c SG	307	if (p) {
8e31681c SG	308	while ((ch = *p++))
45313e83	309	info->putc(info, ch);
8e31681c	310	}
7d9cde10 SR	311	}
	312	}
	313
	314	abort:
7d9cde10 SR	315	return 0;
7d9cde10 SR	316	}
962a43cc	317
4f1eed75 AK	318	#if CONFIG_IS_ENABLED(PRINTF)
	319	static void putc_normal(struct printf_info *info, char ch)
	320	{
	321	putc(ch);
	322	}
	323
da70b4d1 HG	324	int vprintf(const char *fmt, va_list va)
da70b4d1 HG	325	{
45313e83 SG	326	struct printf_info info;
	327
	328	info.putc = putc_normal;
	329	return _vprintf(&info, fmt, va);
da70b4d1 HG	330	}
da70b4d1 HG	331
962a43cc SS	332	int printf(const char *fmt, ...)
962a43cc SS	333	{
45313e83 SG	334	struct printf_info info;
45313e83 SG	335
962a43cc SS	336	va_list va;
	337	int ret;
	338
45313e83	339	info.putc = putc_normal;
962a43cc	340	va_start(va, fmt);
45313e83	341	ret = _vprintf(&info, fmt, va);
5c411d88 SG	342	va_end(va);
	343
	344	return ret;
	345	}
4f1eed75	346	#endif
5c411d88	347
45313e83	348	static void putc_outstr(struct printf_info *info, char ch)
5c411d88	349	{
45313e83	350	*info->outstr++ = ch;
5c411d88 SG	351	}
5c411d88 SG	352
abeb272d	353	int sprintf(char buf, const char fmt, ...)
5c411d88	354	{
45313e83	355	struct printf_info info;
5c411d88 SG	356	va_list va;
	357	int ret;
	358
	359	va_start(va, fmt);
45313e83 SG	360	info.outstr = buf;
	361	info.putc = putc_outstr;
	362	ret = _vprintf(&info, fmt, va);
962a43cc	363	va_end(va);
45313e83	364	*info.outstr = '\0';
962a43cc SS	365
	366	return ret;
	367	}
abeb272d MV	368
	369	/* Note that size is ignored */
	370	int snprintf(char buf, size_t size, const char fmt, ...)
	371	{
45313e83	372	struct printf_info info;
abeb272d MV	373	va_list va;
	374	int ret;
	375
	376	va_start(va, fmt);
45313e83 SG	377	info.outstr = buf;
	378	info.putc = putc_outstr;
	379	ret = _vprintf(&info, fmt, va);
abeb272d	380	va_end(va);
45313e83	381	*info.outstr = '\0';
abeb272d MV	382
	383	return ret;
	384	}