[thirdparty/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 <raj@semihalf.com>
 */

#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 */
};

#undef CONFIG_SYS_64BIT_LBA
#ifdef CONFIG_SYS_64BIT_LBA
typedef	u_int64_t lbasize_t;
#else
typedef unsigned long lbasize_t;
#endif
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 <raj@semihalf.com>
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
6d0f6bcf JCPV	73	#undef CONFIG_SYS_64BIT_LBA
6d0f6bcf JCPV	74	#ifdef CONFIG_SYS_64BIT_LBA
500856eb RJ	75	typedef u_int64_t lbasize_t;
	76	#else
	77	typedef unsigned long lbasize_t;
	78	#endif
	79	typedef unsigned long lbastart_t;
	80
	81	#define DEV_TYP_NONE 0x0000
	82	#define DEV_TYP_NET 0x0001
	83
	84	#define DEV_TYP_STOR 0x0002
	85	#define DT_STOR_IDE 0x0010
	86	#define DT_STOR_SCSI 0x0020
	87	#define DT_STOR_USB 0x0040
	88	#define DT_STOR_MMC 0x0080
f2302d44	89	#define DT_STOR_SATA 0x0100
500856eb RJ	90
	91	#define DEV_STA_CLOSED 0x0000 /* invalid, closed */
	92	#define DEV_STA_OPEN 0x0001 /* open i.e. active */
	93
	94	struct device_info {
	95	int type;
	96	void *cookie;
	97
	98	union {
	99	struct {
	100	lbasize_t block_count; /* no of blocks */
	101	unsigned long block_size; /* size of one block */
	102	} storage;
	103
	104	struct {
	105	unsigned char hwaddr[6];
	106	} net;
	107	} info;
	108	#define di_stor info.storage
	109	#define di_net info.net
	110
	111	int state;
	112	};
	113
a2a5729f CLC	114	#define DISPLAY_TYPE_LCD 0x0001
	115	#define DISPLAY_TYPE_VIDEO 0x0002
	116
	117	struct display_info {
	118	int type;
	119	/* screen size in pixels */
	120	int pixel_width;
	121	int pixel_height;
	122	/* screen size in rows and columns of text */
	123	int screen_rows;
	124	int screen_cols;
	125	};
	126
500856eb	127	#endif /* _API_PUBLIC_H_ */