[people/ms/u-boot.git] / include / api_public.h

/*
 * (C) Copyright 2007-2008 Semihalf
 *
 * Written by: Rafal Jaworowski <raj@semihalf.com>
 *
 * SPDX-License-Identifier:	GPL-2.0+	BSD-2-Clause
 */

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