sys/arm/include/atags.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  28  */
  29
  30 #ifndef __MACHINE_ATAGS_H__
  31 #define __MACHINE_ATAGS_H__
  32
  33 /*
  34  * Linux boot ABI compatable ATAG definitions.  All these structures
  35  * assume tight packing, but since they are all uint32_t's, I've not
  36  * bothered to do the usual alignment dance.
  37  */
  38
  39 #define LBABI_MAX_COMMAND_LINE  1024
  40
  41 struct arm_lbabi_header
  42 {
  43         uint32_t        size;           /* Size of this node, including header */
  44         uint32_t        tag;            /* Node type */
  45 };
  46
  47 #define ATAG_NONE       0x00000000      /* End of atags list */
  48 #define ATAG_CORE       0x54410001      /* List must start with ATAG_CORE */
  49 #define ATAG_MEM        0x54410002      /* Multiple ATAG_MEM nodes possible */
  50 #define ATAG_VIDEOTEXT  0x54410003      /* Video parameters */
  51 #define ATAG_RAMDISK    0x54410004      /* Describes the ramdisk parameters */
  52 #define ATAG_INITRD     0x54410005      /* Deprecated ramdisk -- used va not pa */
  53 #define ATAG_INITRD2    0x54420005      /* compressed ramdisk image */
  54 #define ATAG_SERIAL     0x54410006      /* 64-bits of serial number */
  55 #define ATAG_REVISION   0x54410007      /* Board revision */
  56 #define ATAG_VIDEOLFB   0x54410008      /* vesafb framebuffer */
  57 #define ATAG_CMDLINE    0x54410009      /* Command line */
  58
  59 /*
  60  * ATAG_CORE data
  61  */
  62 struct arm_lbabi_core
  63 {
  64         uint32_t flags;                 /* bit 0 == read-only */
  65         uint32_t pagesize;
  66         uint32_t rootdev;
  67 };
  68
  69 /*
  70  * ATAG_MEM data -- Can be more than one to describe different
  71  * banks.
  72  */
  73 struct arm_lbabi_mem32
  74 {
  75         uint32_t size;
  76         uint32_t start;                 /* start of physical memory */
  77 };
  78
  79 /*
  80  * ATAG_INITRD2 - Compressed ramdisk image details
  81  */
  82 struct arm_lbabi_initrd
  83 {
  84         uint32_t start;                 /* pa of start */
  85         uint32_t size;                  /* How big the ram disk is */
  86 };
  87
  88 /*
  89  * ATAG_SERIAL - serial number
  90  */
  91 struct arm_lbabi_serial_number
  92 {
  93         uint32_t low;
  94         uint32_t high;
  95 };
  96
  97 /*
  98  * ATAG_REVISION - board revision
  99  */
 100 struct arm_lbabi_revision
 101 {
 102         uint32_t rev;
 103 };
 104
 105 /*
 106  * ATAG_CMDLINE - Command line from uboot
 107  */
 108 struct arm_lbabi_command_line
 109 {
 110         char command[1];                /* Minimum command length */
 111 };
 112
 113 struct arm_lbabi_tag
 114 {
 115         struct arm_lbabi_header tag_hdr;
 116         union {
 117                 struct arm_lbabi_core tag_core;
 118                 struct arm_lbabi_mem32 tag_mem;
 119                 struct arm_lbabi_initrd tag_initrd;
 120                 struct arm_lbabi_serial_number tag_sn;
 121                 struct arm_lbabi_revision tag_rev;
 122                 struct arm_lbabi_command_line tag_cmd;
 123         } u;
 124 };
 125
 126 #define ATAG_TAG(a)  (a)->tag_hdr.tag
 127 #define ATAG_SIZE(a) ((a)->tag_hdr.size * sizeof(uint32_t))
 128 #define ATAG_NEXT(a) (struct arm_lbabi_tag *)((char *)(a) + ATAG_SIZE(a))
 129
 130 #endif /* __MACHINE_ATAGS_H__ */