source: soft/giet_vm/xml/mapping_info.h @ 249

Last change on this file since 249 was 249, checked in by alain, 11 years ago

Various modifications to support IO Bridge,
and MEMC configuration interface.
File size: 11.3 KB
Line 
1////////////////////////////////////////////////////////////////////////////
2// File     : mapping_info.h
3// Date     : 01/04/2012
4// Author   : alain greiner
5// Copyright (c) UPMC-LIP6
6////////////////////////////////////////////////////////////////////////////
7// The MAPPING_INFO data structure can be used with the GIET.
8// It contains the mapping directive for one or several virtual spaces.
9// Ech virtual space contains a variable number of virtual segments
10// and a variable number of tasks. The number of virtual space can be one.
11//
12// The mapping table data structure is organised as the concatenation of
13// a fixed size header, and 6 variable size arrays:
14//
15// - mapping_cluster_t  cluster[] 
16// - mapping_pseg_t     pseg[]       
17// - mapping_vspace_t   vspace[] 
18// - mapping_vseg_t     vseg[]     
19// - mapping_vseg_t     vobj[]   
20// - mapping_task_t     task[] 
21// - mapping_irq_t      irq[irqs]   
22// - mapping_coproc_t   coproc[]
23// - mapping_cp_port_t  cp_port[]
24// - mapping_periph_t   periph[]
25//
26// It is intended to be stored in the boot ROM at address MAPPING_BOOT_BASE.
27////////////////////////////////////////////////////////////////////////////
28
29#ifndef _MAPPING_INFO_H_
30#define _MAPPING_INFO_H_
31
32#define MAPPING_HEADER_SIZE   sizeof(mapping_header_t)
33#define MAPPING_CLUSTER_SIZE  sizeof(mapping_cluster_t)
34#define MAPPING_VSPACE_SIZE   sizeof(mapping_vspace_t)
35#define MAPPING_VSEG_SIZE     sizeof(mapping_vseg_t)
36#define MAPPING_VOBJ_SIZE     sizeof(mapping_vobj_t)
37#define MAPPING_PSEG_SIZE     sizeof(mapping_pseg_t)
38#define MAPPING_TASK_SIZE     sizeof(mapping_task_t)
39#define MAPPING_PROC_SIZE     sizeof(mapping_proc_t)
40#define MAPPING_IRQ_SIZE      sizeof(mapping_irq_t)
41#define MAPPING_COPROC_SIZE   sizeof(mapping_coproc_t)
42#define MAPPING_CP_PORT_SIZE  sizeof(mapping_cp_port_t)
43
44#define C_MODE_MASK  0b1000 // cacheable
45#define X_MODE_MASK  0b0100 // executable
46#define W_MODE_MASK  0b0010 // writable
47#define U_MODE_MASK  0b0001 // user access
48
49#define IN_MAPPING_SIGNATURE    0xDEADBEEF
50#define OUT_MAPPING_SIGNATURE   0xBABEF00D
51
52typedef unsigned long long  paddr_t;
53
54enum vobjType
55{
56    VOBJ_TYPE_ELF      = 0,  // loadable code/data object of elf files
57    VOBJ_TYPE_BLOB     = 1,  // loadable blob object
58    VOBJ_TYPE_PTAB     = 2,  // page table
59    VOBJ_TYPE_PERI     = 3,  // hardware component
60    VOBJ_TYPE_MWMR     = 4,  // MWMR channel
61    VOBJ_TYPE_LOCK     = 5,  // Lock
62    VOBJ_TYPE_BUFFER   = 6,  // Any "no initialization" objects (stacks...)
63    VOBJ_TYPE_BARRIER  = 7,  // Barrier
64    VOBJ_TYPE_CONST    = 8,  // Constant
65    VOBJ_TYPE_MEMSPACE = 9,  // Memspace (descriptor must be initialised)
66    VOBJ_TYPE_SCHED    = 10, // Array of schedulers (one per cluster)
67};
68
69
70enum psegType
71{
72    PSEG_TYPE_RAM  = 0,
73    PSEG_TYPE_ROM  = 1,
74    PSEG_TYPE_PERI = 2,
75};
76
77
78enum periphType
79{
80    PERIPH_TYPE_ICU       = 0,
81    PERIPH_TYPE_TIM       = 1,
82    PERIPH_TYPE_DMA       = 2,
83    PERIPH_TYPE_MMC       = 3,
84
85    PERIPH_TYPE_CMA       = 4,
86    PERIPH_TYPE_IOC       = 5,
87    PERIPH_TYPE_TTY       = 6,
88    PERIPH_TYPE_FBF       = 7,
89    PERIPH_TYPE_NIC       = 8,
90    PERIPH_TYPE_IOB       = 9,
91    PERIPH_TYPE_GCD       = 10,
92
93    PERIPH_TYPE_MAX_VALUE = 11,
94};
95
96
97enum mwmrPortDirection
98{
99    PORT_TO_COPROC   = 0, // status register
100    PORT_FROM_COPROC = 1, // config register
101};
102
103
104///////////////////////////////
105
106typedef struct __attribute__((packed))  mapping_header_s
107{
108    unsigned int signature;          // must contain MAPPING_SIGNATURE
109    unsigned int clusters;           // number of clusters
110    unsigned int cluster_x;          // number of cluster in a row
111    unsigned int cluster_y;          // number of cluster in a column
112    unsigned int globals;            // number of vsegs mapped in all vspaces
113    unsigned int vspaces;            // number of virtual spaces
114
115    unsigned int tty_cluster;        // index of cluster containing TTY controler
116    unsigned int tty_cluster_bis;    // index of cluster containing second TTY controler
117    unsigned int ioc_cluster;        // index of cluster containing IOC controler
118    unsigned int ioc_cluster_bis;    // index of cluster containing second IOC controler
119    unsigned int nic_cluster;        // index of cluster containing NIC controler
120    unsigned int nic_cluster_bis;    // index of cluster containing second NIC controler
121    unsigned int fbf_cluster;        // index of cluster containing FBF controler
122    unsigned int fbf_cluster_bis;    // index of cluster containing second FBF controler
123    unsigned int cma_cluster;        // index of cluster containing CMA controler
124    unsigned int cma_cluster_bis;    // index of cluster containing second CMA controler
125    unsigned int iob_cluster;        // index of cluster containing IOB controler
126    unsigned int iob_cluster_bis;    // index of cluster containing second IOB controler
127
128    unsigned int psegs;              // total number of physical segments (for all clusters)
129    unsigned int vsegs;              // total number of virtual segments (for all vspaces)
130    unsigned int vobjs;              // total number of virtual objects (for all vspaces)
131    unsigned int tasks;              // total number of tasks (for all vspaces)
132    unsigned int procs;              // total number of procs (for all clusters)
133    unsigned int irqs;               // total number of irqs (for all processors)
134    unsigned int coprocs;            // total number of coprocs (for all clusters)
135    unsigned int cp_ports;           // total number of cp_ports (for all coprocs)
136    unsigned int periphs;            // total number of peripherals (for all clusters)
137
138    char name[32];                   // mapping name
139} mapping_header_t;
140
141
142////////////////////////////////
143typedef struct __attribute__((packed))  mapping_cluster_s
144{
145    unsigned int psegs;          // number of psegs in cluster
146    unsigned int pseg_offset;    // index of first pseg in pseg set
147
148    unsigned int procs;          // number of processors in cluster
149    unsigned int proc_offset;    // index of first proc in proc set
150
151    unsigned int coprocs;        // number of coprocessors in cluster
152    unsigned int coproc_offset;  // index of first coproc in coproc set
153
154    unsigned int periphs;        // number of peripherals in cluster
155    unsigned int periph_offset;  // index of first coproc in coproc set
156} mapping_cluster_t;
157
158
159/////////////////////////////
160typedef struct __attribute__((packed))  mapping_pseg_s 
161{
162    char         name[32];       // pseg name (unique in a cluster)
163    paddr_t      base;           // base address in physical space
164    paddr_t      length;         // size (bytes)
165    unsigned int type;           // RAM / ROM / PERI
166    unsigned int cluster;        // index of cluster containing pseg
167    paddr_t      next_base;      // first free page base address
168} mapping_pseg_t;
169
170
171///////////////////////////////
172typedef struct __attribute__((packed))  mapping_vspace_s
173{
174    char         name[32];       // virtual space name
175    unsigned int start_offset;   // offset of the vobj containing the start vector
176    unsigned int vsegs;          // number of vsegs in vspace
177    unsigned int vobjs;          // number of vobjs in vspace
178    unsigned int tasks;          // number of tasks in vspace
179    unsigned int vseg_offset;    // index of first vseg in vspace
180    unsigned int vobj_offset;    // index of first vobjs in vspace
181    unsigned int task_offset;    // index of first task in vspace
182} mapping_vspace_t;
183
184
185/////////////////////////////
186typedef struct __attribute__((packed))  mapping_vseg_s
187{
188    char         name[32];       // vseg name (unique in vspace)
189    unsigned int vbase;          // base address in virtual space
190    paddr_t      pbase;          // base address in physical space
191    unsigned int length;         // size (bytes)
192    unsigned int psegid;         // physical segment global index
193    unsigned int mode;           // C-X-W-U flags
194    unsigned int ident;          // identity mapping if non zero
195    unsigned int vobjs;          // number of vobjs in vseg
196    unsigned int vobj_offset;    // index of first vobj in vseg
197} mapping_vseg_t;
198
199
200/////////////////////////////
201typedef struct __attribute__((packed))  mapping_task_s
202{
203    char         name[32];       // task name (unique in vspace)
204    unsigned int clusterid;      // physical cluster index
205    unsigned int proclocid;      // processor local index (inside cluster)
206    unsigned int stack_vobjid;   // stack vobj index in vspace
207    unsigned int heap_vobjid;    // heap vobj index in vspace
208    unsigned int startid;        // index in start_vector
209    unsigned int use_tty;        // TTY channel required (global)
210    unsigned int use_nic;        // NIC channel required (global)
211    unsigned int use_cma;        // CMA channel required (global)
212    unsigned int use_ioc;        // IOC channel required (global)
213    unsigned int use_tim;        // user timer required (local)
214    unsigned int use_dma;        // DMA channel required (local)
215} mapping_task_t;
216
217
218/////////////////////////////
219typedef struct __attribute__((packed))  mapping_vobj_s
220{
221    char         name[32];       // vobj name (unique in a vspace)
222    char         binpath[64];    // path for the binary code ("*.elf")
223    unsigned int type;           // type of vobj
224    unsigned int length;         // size (bytes)
225    unsigned int align;          // required alignement (logarithm of 2)
226    unsigned int vaddr;          // virtual base addresse of the vobj
227    paddr_t      paddr;          // physical base addresse of the vobj
228    unsigned int init;           // init value (used by barrier or mwmr channel)
229} mapping_vobj_t;
230
231
232/////////////////////////////
233typedef struct __attribute__((packed))  mapping_proc_s
234{
235    unsigned int irqs;           // number of IRQs allocated to processor
236    unsigned int irq_offset;     // index of first IRQ allocated to processor
237} mapping_proc_t;
238
239
240/////////////////////////////
241typedef struct __attribute__((packed))  mapping_irq_s
242{
243    unsigned int type;           // 0 => HW_IRQ  / 1 => SW_IRQ
244    unsigned int icuid;          // IRQ Index for the ICU component
245    unsigned int isr;            // ISR Index (defined in irq_handler.h)
246    unsigned int channel;        // Channel Index (for multi-channels peripherals)
247} mapping_irq_t;
248
249
250///////////////////////////////
251typedef struct __attribute__((packed))  mapping_coproc_s
252{
253    char         name[32];       // coprocessor name
254    unsigned int psegid;         // global pseg index
255    unsigned int ports;          // number of MWMR ports used by coprocessor
256    unsigned int port_offset;    // index of first MWMR port used by coprocessor
257} mapping_coproc_t;
258
259
260////////////////////////////////
261typedef struct __attribute__((packed))  mapping_cp_port_s
262{
263    unsigned int direction;      // TO_COPROC == 0 / FROM_COPROC == 1
264    unsigned int vspaceid;       // index of the vspace containing the MWMR channel
265    unsigned int mwmr_vobjid;    // local index of the vobj containing the MWMR channel
266} mapping_cp_port_t;
267
268
269///////////////////////////////
270typedef struct __attribute__((packed))  mapping_periph_s
271{
272    unsigned int type;           // IOC / TTY / TIM / DMA / FBF / NIC / IOB
273    unsigned int psegid;         // pseg index in cluster
274    unsigned int channels;       // number of channels
275} mapping_periph_t;
276
277
278#endif
279
280// Local Variables:
281// tab-width: 4
282// c-basic-offset: 4
283// c-file-offsets:((innamespace . 0)(inline-open . 0))
284// indent-tabs-mode: nil
285// End:
286
287// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
288
Note: See TracBrowser for help on using the repository browser.