xref: /freebsd/sys/arm/include/atags.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 M. Warner Losh <imp@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef	__MACHINE_ATAGS_H__
29 #define __MACHINE_ATAGS_H__
30 
31 /*
32  * Linux boot ABI compatable ATAG definitions.  All these structures
33  * assume tight packing, but since they are all uint32_t's, I've not
34  * bothered to do the usual alignment dance.
35  */
36 
37 #define	LBABI_MAX_COMMAND_LINE  1024
38 
39 struct arm_lbabi_header
40 {
41 	uint32_t	size;		/* Size of this node, including header */
42 	uint32_t	tag;		/* Node type */
43 };
44 
45 #define	ATAG_NONE       0x00000000	/* End of atags list */
46 #define	ATAG_CORE	0x54410001	/* List must start with ATAG_CORE */
47 #define	ATAG_MEM	0x54410002	/* Multiple ATAG_MEM nodes possible */
48 #define	ATAG_VIDEOTEXT	0x54410003	/* Video parameters */
49 #define	ATAG_RAMDISK	0x54410004	/* Describes the ramdisk parameters */
50 #define	ATAG_INITRD	0x54410005	/* Deprecated ramdisk -- used va not pa */
51 #define	ATAG_INITRD2	0x54420005	/* compressed ramdisk image */
52 #define	ATAG_SERIAL	0x54410006	/* 64-bits of serial number */
53 #define	ATAG_REVISION	0x54410007	/* Board revision */
54 #define	ATAG_VIDEOLFB	0x54410008	/* vesafb framebuffer */
55 #define	ATAG_CMDLINE	0x54410009	/* Command line */
56 
57 /*
58  * ATAG_CORE data
59  */
60 struct arm_lbabi_core
61 {
62 	uint32_t flags;			/* bit 0 == read-only */
63 	uint32_t pagesize;
64 	uint32_t rootdev;
65 };
66 
67 /*
68  * ATAG_MEM data -- Can be more than one to describe different
69  * banks.
70  */
71 struct arm_lbabi_mem32
72 {
73 	uint32_t size;
74 	uint32_t start;			/* start of physical memory */
75 };
76 
77 /*
78  * ATAG_INITRD2 - Compressed ramdisk image details
79  */
80 struct arm_lbabi_initrd
81 {
82 	uint32_t start;			/* pa of start */
83 	uint32_t size;			/* How big the ram disk is */
84 };
85 
86 /*
87  * ATAG_SERIAL - serial number
88  */
89 struct arm_lbabi_serial_number
90 {
91 	uint32_t low;
92 	uint32_t high;
93 };
94 
95 /*
96  * ATAG_REVISION - board revision
97  */
98 struct arm_lbabi_revision
99 {
100 	uint32_t rev;
101 };
102 
103 /*
104  * ATAG_CMDLINE - Command line from uboot
105  */
106 struct arm_lbabi_command_line
107 {
108 	char command[1];		/* Minimum command length */
109 };
110 
111 struct arm_lbabi_tag
112 {
113 	struct arm_lbabi_header tag_hdr;
114 	union {
115 		struct arm_lbabi_core tag_core;
116 		struct arm_lbabi_mem32 tag_mem;
117 		struct arm_lbabi_initrd tag_initrd;
118 		struct arm_lbabi_serial_number tag_sn;
119 		struct arm_lbabi_revision tag_rev;
120 		struct arm_lbabi_command_line tag_cmd;
121 	} u;
122 };
123 
124 #define	ATAG_TAG(a)  (a)->tag_hdr.tag
125 #define ATAG_SIZE(a) ((a)->tag_hdr.size * sizeof(uint32_t))
126 #define ATAG_NEXT(a) (struct arm_lbabi_tag *)((char *)(a) + ATAG_SIZE(a))
127 
128 #endif /* __MACHINE_ATAGS_H__ */
129