c66x: corrected PREDIV and updated size limitations in utils
[keystone-rtos/ibl.git] / src / util / romparse / romparse.h
1 /*
2  *
3  * Copyright (C) 2010-2017 Texas Instruments Incorporated - http://www.ti.com/
4  *
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  *
10  *    Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  *
13  *    Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the
16  *    distribution.
17  *
18  *    Neither the name of Texas Instruments Incorporated nor the names of
19  *    its contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34 */
38 #ifndef _ROMPARSE_H
39 #define _ROMPARSE_H
40 /*************************************************************************************
41  * FILE PURPOSE: Define boot data structures
42  *************************************************************************************
43  * FILE NAME: romparse.h
44  *
45  * DESCRIPTION: Defines the structures used to create the boot parameter
46  *                              table
47  *
48  *************************************************************************************/
50 /* tiboot.h defines the boot parameters structure that will be created */
51 #if defined(c6472)
52  #include "tiboot_c6472.h"
53 #elif defined(c6474) || defined(c6474l)
54  #include "tiboot_c6474.h"
55 #elif defined(c6455)
56  #include "tiboot_c6455.h"
57 #elif defined(c6457)
58  #include "tiboot_c6457.h"
59 #elif defined(c66x)
60  #include "tiboot_c66x.h"
61 #elif defined(c665x)
62  #include "tiboot_c665x.h"
63 #elif defined(c66xk2x)
64  #include "tiboot_c66xk2x.h"
65 #else
66  #error invalid or missing device specification
67 #endif
69 /* Define the number of boot parameter tables that will be put on the rom */
70 #define NUM_BOOT_PARAM_TABLES   8
72 /* Define the size reserved for the PCI configuration table */
73 #define PCI_EEAI_PARAM_SIZE    0x20
75 /* Define a structure mapping the boot parameter table number to a program file
76  * to an eeprom byte address */
77 #define MAX_FNAME_LEN        132
78 #define MAX_DATA_LEN_32bit   0x200000
79 typedef struct {
80   char fname[MAX_FNAME_LEN];
81   int  sizeBytes;
82   unsigned int  addressBytes;
83   unsigned int data[MAX_DATA_LEN_32bit];
84   int  tag[NUM_BOOT_PARAM_TABLES];          /* identifies boot parameter tables which use this file */
85   int  align;                               /* alignment requirements for the file */
86 } progFile_t;
88 /* Define the PCI parameter structure */
89 #define PCI_DATA_LEN_32bit  8
90 typedef struct {
91   char fname[MAX_FNAME_LEN];
92   int sizeBytes;
93   int addressBytes;
94   unsigned int data[PCI_DATA_LEN_32bit];
95 } pciFile_t;
98 /* Distinguish between a layout and pad */
99 #define PLT_PAD     10
100 #define PLT_FILE    11
101 typedef struct {
102   int type;
103   int index;
104 } plt_t;
106 /* Define a layout table. A layout table is a block of data which contains the addresses
107  * of data files. Each address is 32 bits, with the upper 16 bits specifying the i2c
108  * id, the lower address the byte address of the 1st block in the table */
109 #define MAX_LAYOUTS         2
110 #define MAX_LAYOUT_FILES    8
111 typedef struct  {
112   int nPlt;                      /* Number of elements in the plt array */
113   plt_t plt[MAX_LAYOUT_FILES];   /* Index of each file/pad in order */
115   unsigned int address;         /* I2c data address of the table */
116   unsigned int dev_addr;        /* I2c device address of the table */
117   int align;
118 } layout_t;
121 /* Pad section. The pad section creates a gap in the i2c memory map */
122 #define MAX_PADS        8
123 typedef struct  {
124   int          id;
125   unsigned int address;     /* I2C data address */
126   unsigned int dev_addr;    /* I2C device address */
127   unsigned int len;
128 } pad_t;
131 /* Layout/pad interleave. The rom specification must be in order, so this structure tracks
132  * the arrangement of layouts and pads */
133 typedef struct
135   int type;   /* Either PAD or LAYOUT */
136   int index;  /* The array index for the pad/layout */
138 } padLayoutOrder_t;
143 #endif /* ROMPARSE_H */