[J-u-boot.git] / include / api_public.h

/* SPDX-License-Identifier: GPL-2.0+ OR BSD-2-Clause */
/*
 * (C) Copyright 2007-2008 Semihalf
 *
 * Written by: Rafal Jaworowski <[email protected]>
 */

#ifndef _API_PUBLIC_H_
#define _API_PUBLIC_H_

#define API_EINVAL		1	/* invalid argument(s)	*/
#define API_ENODEV		2	/* no device		*/
#define API_ENOMEM		3	/* no memory		*/
#define API_EBUSY		4	/* busy, occupied etc.	*/
#define API_EIO			5	/* I/O error		*/
#define API_ESYSC		6	/* syscall error	*/

typedef	int (*scp_t)(int, int *, ...);

#define API_SIG_VERSION	1
#define API_SIG_MAGIC	"UBootAPI"
#define API_SIG_MAGLEN	8

struct api_signature {
	char		magic[API_SIG_MAGLEN];	/* magic string */
	uint16_t	version;		/* API version */
	uint32_t	checksum;		/* checksum of this sig struct */
	scp_t		syscall;		/* entry point to the API */
};

enum {
	API_RSVD = 0,
	API_GETC,
	API_PUTC,
	API_TSTC,
	API_PUTS,
	API_RESET,
	API_GET_SYS_INFO,
	API_UDELAY,
	API_GET_TIMER,
	API_DEV_ENUM,
	API_DEV_OPEN,
	API_DEV_CLOSE,
	API_DEV_READ,
	API_DEV_WRITE,
	API_ENV_ENUM,
	API_ENV_GET,
	API_ENV_SET,
	API_DISPLAY_GET_INFO,
	API_DISPLAY_DRAW_BITMAP,
	API_DISPLAY_CLEAR,
	API_MAXCALL
};

#define MR_ATTR_FLASH	0x0001
#define MR_ATTR_DRAM	0x0002
#define MR_ATTR_SRAM	0x0003

struct mem_region {
	unsigned long	start;
	unsigned long	size;
	int		flags;
};

struct sys_info {
	unsigned long		clk_bus;
	unsigned long		clk_cpu;
	unsigned long		bar;
	struct mem_region	*mr;
	int			mr_no;	/* number of memory regions */
};

/*
 * FIXME: Previously this code was:
 *
 *   #undef CONFIG_SYS_64BIT_LBA
 *   #ifdef CONFIG_SYS_64BIT_LBA
 *   typedef u_int64_t lbasize_t;
 *   #else
 *   typedef unsigned long lbasize_t;
 *   #endif
 *
 * But we cannot just undefine CONFIG_SYS_64BIT_LBA, because then in
 * api/api_storage.c the type signature of lbaint_t will be different if
 * CONFIG_SYS_64BIT_LBA is enabled for the board, which can result in various
 * bugs.
 * So simply define lbasize_t as an unsigned long, since this was what was done
 * anyway for at least 13 years, but don't undefine CONFIG_SYS_64BIT_LBA.
 */
typedef unsigned long lbasize_t;

typedef unsigned long lbastart_t;

#define DEV_TYP_NONE	0x0000
#define DEV_TYP_NET	0x0001

#define DEV_TYP_STOR	0x0002
#define DT_STOR_IDE	0x0010
#define DT_STOR_SCSI	0x0020
#define DT_STOR_USB	0x0040
#define DT_STOR_MMC	0x0080
#define DT_STOR_SATA	0x0100

#define DEV_STA_CLOSED	0x0000		/* invalid, closed */
#define DEV_STA_OPEN	0x0001		/* open i.e. active */

struct device_info {
	int	type;
	void	*cookie;

	union {
		struct {
			lbasize_t	block_count;	/* no of blocks */
			unsigned long	block_size;	/* size of one block */
		} storage;

		struct {
			unsigned char	hwaddr[6];
		} net;
	} info;
#define di_stor info.storage
#define di_net info.net

	int	state;
};

#define DISPLAY_TYPE_LCD	0x0001
#define DISPLAY_TYPE_VIDEO	0x0002

struct display_info {
	int type;
	/* screen size in pixels */
	int pixel_width;
	int pixel_height;
	/* screen size in rows and columns of text */
	int screen_rows;
	int screen_cols;
};

#endif /* _API_PUBLIC_H_ */
Commit	Line	Data
4549e789	1	/* SPDX-License-Identifier: GPL-2.0+ OR BSD-2-Clause */
e7a85f26 RJ	2	/*
	3	* (C) Copyright 2007-2008 Semihalf
	4	*
	5	* Written by: Rafal Jaworowski <[email protected]>
e7a85f26 RJ	6	*/
e7a85f26 RJ	7
500856eb RJ	8	#ifndef _API_PUBLIC_H_
	9	#define _API_PUBLIC_H_
	10
	11	#define API_EINVAL 1 /* invalid argument(s) */
	12	#define API_ENODEV 2 /* no device */
	13	#define API_ENOMEM 3 /* no memory */
	14	#define API_EBUSY 4 /* busy, occupied etc. */
	15	#define API_EIO 5 /* I/O error */
923aa481	16	#define API_ESYSC 6 /* syscall error */
500856eb RJ	17
	18	typedef int (scp_t)(int, int , ...);
	19
	20	#define API_SIG_VERSION 1
	21	#define API_SIG_MAGIC "UBootAPI"
	22	#define API_SIG_MAGLEN 8
	23
	24	struct api_signature {
	25	char magic[API_SIG_MAGLEN]; /* magic string */
	26	uint16_t version; /* API version */
	27	uint32_t checksum; /* checksum of this sig struct */
	28	scp_t syscall; /* entry point to the API */
	29	};
	30
	31	enum {
	32	API_RSVD = 0,
	33	API_GETC,
	34	API_PUTC,
	35	API_TSTC,
	36	API_PUTS,
	37	API_RESET,
	38	API_GET_SYS_INFO,
	39	API_UDELAY,
	40	API_GET_TIMER,
	41	API_DEV_ENUM,
	42	API_DEV_OPEN,
	43	API_DEV_CLOSE,
	44	API_DEV_READ,
	45	API_DEV_WRITE,
	46	API_ENV_ENUM,
	47	API_ENV_GET,
	48	API_ENV_SET,
a2a5729f CLC	49	API_DISPLAY_GET_INFO,
	50	API_DISPLAY_DRAW_BITMAP,
	51	API_DISPLAY_CLEAR,
500856eb RJ	52	API_MAXCALL
	53	};
	54
	55	#define MR_ATTR_FLASH 0x0001
	56	#define MR_ATTR_DRAM 0x0002
	57	#define MR_ATTR_SRAM 0x0003
	58
	59	struct mem_region {
	60	unsigned long start;
	61	unsigned long size;
	62	int flags;
	63	};
	64
	65	struct sys_info {
	66	unsigned long clk_bus;
	67	unsigned long clk_cpu;
	68	unsigned long bar;
	69	struct mem_region *mr;
	70	int mr_no; /* number of memory regions */
	71	};
	72
d32211ee MB	73	/*
	74	* FIXME: Previously this code was:
	75	*
	76	* #undef CONFIG_SYS_64BIT_LBA
	77	* #ifdef CONFIG_SYS_64BIT_LBA
	78	* typedef u_int64_t lbasize_t;
	79	* #else
	80	* typedef unsigned long lbasize_t;
	81	* #endif
	82	*
	83	* But we cannot just undefine CONFIG_SYS_64BIT_LBA, because then in
	84	* api/api_storage.c the type signature of lbaint_t will be different if
	85	* CONFIG_SYS_64BIT_LBA is enabled for the board, which can result in various
	86	* bugs.
	87	* So simply define lbasize_t as an unsigned long, since this was what was done
	88	* anyway for at least 13 years, but don't undefine CONFIG_SYS_64BIT_LBA.
	89	*/
500856eb	90	typedef unsigned long lbasize_t;
d32211ee	91
500856eb RJ	92	typedef unsigned long lbastart_t;
	93
	94	#define DEV_TYP_NONE 0x0000
	95	#define DEV_TYP_NET 0x0001
	96
	97	#define DEV_TYP_STOR 0x0002
	98	#define DT_STOR_IDE 0x0010
	99	#define DT_STOR_SCSI 0x0020
	100	#define DT_STOR_USB 0x0040
	101	#define DT_STOR_MMC 0x0080
f2302d44	102	#define DT_STOR_SATA 0x0100
500856eb RJ	103
	104	#define DEV_STA_CLOSED 0x0000 /* invalid, closed */
	105	#define DEV_STA_OPEN 0x0001 /* open i.e. active */
	106
	107	struct device_info {
	108	int type;
	109	void *cookie;
	110
	111	union {
	112	struct {
	113	lbasize_t block_count; /* no of blocks */
	114	unsigned long block_size; /* size of one block */
	115	} storage;
	116
	117	struct {
	118	unsigned char hwaddr[6];
	119	} net;
	120	} info;
	121	#define di_stor info.storage
	122	#define di_net info.net
	123
	124	int state;
	125	};
	126
a2a5729f CLC	127	#define DISPLAY_TYPE_LCD 0x0001
	128	#define DISPLAY_TYPE_VIDEO 0x0002
	129
	130	struct display_info {
	131	int type;
	132	/* screen size in pixels */
	133	int pixel_width;
	134	int pixel_height;
	135	/* screen size in rows and columns of text */
	136	int screen_rows;
	137	int screen_cols;
	138	};
	139
500856eb	140	#endif /* _API_PUBLIC_H_ */