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

Last change on this file since 233 was 232, checked in by meunier, 12 years ago

Ajout du malloc dans le Giet.
File size: 10.0 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
52enum vobjType {
53    VOBJ_TYPE_ELF      = 0, // loadable code/data object of elf files
54    VOBJ_TYPE_BLOB     = 1, // loadable blob object
55    VOBJ_TYPE_PTAB     = 2, // page table
56    VOBJ_TYPE_PERI     = 3, // hardware component
57    VOBJ_TYPE_MWMR     = 4, // MWMR channel
58    VOBJ_TYPE_LOCK     = 5, // Lock
59    VOBJ_TYPE_BUFFER   = 6, // Any "no initialization needed" objects (stacks...)
60    VOBJ_TYPE_BARRIER  = 7, // Barrier
61    VOBJ_TYPE_CONST    = 8, // Constant
62    VOBJ_TYPE_MEMSPACE = 9, // Memspace; different from buffer because we add infos at the beginning
63};
64
65
66enum psegType {
67    PSEG_TYPE_RAM  = 0,
68    PSEG_TYPE_ROM  = 1,
69    PSEG_TYPE_PERI = 2,
70};
71
72
73enum periphType {
74    PERIPH_TYPE_ICU  = 0,
75    PERIPH_TYPE_TIM  = 1,
76    PERIPH_TYPE_XICU = 2,
77    PERIPH_TYPE_DMA  = 3,
78    PERIPH_TYPE_IOC  = 4,
79    PERIPH_TYPE_TTY  = 5,
80    PERIPH_TYPE_FBF  = 6,
81    PERIPH_TYPE_NIC  = 7,
82    PERIPH_TYPE_IOB  = 8,
83};
84
85
86enum mwmrPortDirection {
87    PORT_TO_COPROC   = 0, // status register
88    PORT_FROM_COPROC = 1, // config register
89};
90
91
92///////////////////////////////
93
94typedef struct mapping_header_s {
95    unsigned int signature;      // must contain MAPPING_SIGNATURE
96    unsigned int clusters;       // number of clusters
97    unsigned int cluster_x;      // number of cluster on the abcsisse axe
98    unsigned int cluster_y;      // number of cluster on the ordinate axe
99    unsigned int globals;        // number of vsegs mapped in all vspaces
100    unsigned int vspaces;        // number of virtual spaces
101
102    unsigned int tty_clusterid;  // index of cluster containing TTY controler
103    unsigned int ioc_clusterid;  // index of cluster containing IOC controler
104    unsigned int nic_clusterid;  // index of cluster containing NIC controler
105    unsigned int fbf_clusterid;  // index of cluster containing FBF controler
106
107    unsigned int psegs;          // total number of physical segments (for all clusters)
108    unsigned int vsegs;          // total number of virtual segments (for all vspaces)
109    unsigned int vobjs;          // total number of virtual objects (for all vspaces)
110    unsigned int tasks;          // total number of tasks (for all vspaces)
111    unsigned int procs;          // total number of procs (for all clusters)
112    unsigned int irqs;           // total number of irqs (for all processors)
113    unsigned int coprocs;        // total number of coprocs (for all clusters)
114    unsigned int cp_ports;       // total number of cp_ports (for all coprocs)
115    unsigned int periphs;        // total number of peripherals (for all clusters)
116
117    char name[32];    // mapping name
118} mapping_header_t;
119
120
121////////////////////////////////
122typedef struct mapping_cluster_s {
123    unsigned int psegs;          // number of psegs in cluster
124    unsigned int pseg_offset;    // index of first pseg in pseg set
125
126    unsigned int procs;          // number of processors in cluster
127    unsigned int proc_offset;    // index of first proc in proc set
128
129    unsigned int coprocs;        // number of coprocessors in cluster
130    unsigned int coproc_offset;  // index of first coproc in coproc set
131
132    unsigned int periphs;        // number of peripherals in cluster
133    unsigned int periph_offset;  // index of first coproc in coproc set
134} mapping_cluster_t;
135
136
137/////////////////////////////
138typedef struct mapping_pseg_s  {
139    char name[32];               // pseg name (unique in a cluster)
140    unsigned int base;           // base address in physical space
141    unsigned int length;         // size (bytes)
142    unsigned int type;           // RAM / ROM / PERI
143    unsigned int cluster;        // index of cluster containing pseg
144    unsigned int next_base;      // first free page base address
145} mapping_pseg_t;
146
147
148///////////////////////////////
149typedef struct mapping_vspace_s {
150    char name[32];               // virtual space name
151    unsigned int start_offset;   // offset of the vobj containing the start vector
152    unsigned int vsegs;          // number of vsegs in vspace
153    unsigned int vobjs;          // number of vobjs in vspace
154    unsigned int tasks;          // number of tasks in vspace
155    unsigned int vseg_offset;    // index of first vseg in vspace
156    unsigned int vobj_offset;    // index of first vobjs in vspace
157    unsigned int task_offset;    // index of first task in vspace
158} mapping_vspace_t;
159
160
161/////////////////////////////
162typedef struct mapping_vseg_s {
163    char name[32];               // vseg name (unique in vspace)
164    unsigned int vbase;          // base address in virtual space (hexa)
165    unsigned int pbase;          // base address in physical space (hexa)
166    unsigned int length;         // size (bytes)
167    unsigned int psegid;         // physical segment global index
168    unsigned int mode;           // C-X-W-U flags
169    unsigned int ident;          // identity mapping if non zero
170    unsigned int vobjs;          // number of vobjs in vseg
171    unsigned int vobj_offset;    // index of first vobjs in vseg
172} mapping_vseg_t;
173
174
175/////////////////////////////
176typedef struct mapping_task_s {
177    char name[32];               // task name (unique in vspace)
178    unsigned int clusterid;      // physical cluster index
179    unsigned int proclocid;      // processor local index (inside cluster)
180    unsigned int stack_vobjid;   // stack vobj index in vspace
181    unsigned int heap_vobjid;    // heap vobj index in vspace
182    unsigned int startid;        // index in start_vector
183    unsigned int use_tty;        // TTY terminal required (global)
184    unsigned int use_nic;        // NIC channel required (global)
185    unsigned int use_timer;      // user timer required (local)
186    unsigned int use_fbdma;      // DMA channel to frame buffer required (local)
187} mapping_task_t;
188
189
190/////////////////////////////
191typedef struct mapping_vobj_s {
192    char name[32];               // vobj name (unique in a vspace)
193    char binpath[64];            // path for the binary code ("*.elf")
194    unsigned int type;           // type of vobj
195    unsigned int length;         // size (bytes)
196    unsigned int align;          // required alignement (logarithm of 2)
197    unsigned int vaddr;          // virtual base addresse of the vobj
198    unsigned int paddr;          // physical base addresse of the vobj
199    unsigned int init;           // init value (used by barrier or mwmr channel)
200} mapping_vobj_t;
201
202
203/////////////////////////////
204typedef struct mapping_proc_s {
205    unsigned int irqs;           // number of IRQs allocated to processor
206    unsigned int irq_offset;     // index of first IRQ allocated to processor
207} mapping_proc_t;
208
209
210/////////////////////////////
211typedef struct mapping_irq_s {
212    unsigned int type;           // 0 => HW_IRQ  / 1 => SW_IRQ
213    unsigned int icuid;          // IRQ Index for the ICU component
214    unsigned int isr;            // Interrupt Service Routine Index
215    unsigned int channel;        // Channel Index (for multi-cannels peripherals)
216} mapping_irq_t;
217
218
219///////////////////////////////
220typedef struct mapping_coproc_s {
221    char name[32];               // coprocessor name
222    unsigned int psegid;         // global pseg index
223    unsigned int ports;          // number of MWMR ports used by coprocessor
224    unsigned int port_offset;    // index of first MWMR port used by coprocessor
225} mapping_coproc_t;
226
227
228////////////////////////////////
229typedef struct mapping_cp_port_s {
230    unsigned int direction;      // TO_COPROC == 0 / FROM_COPROC == 1
231    unsigned int vspaceid;       // index of the vspace containing the MWMR channel
232    unsigned int mwmr_vobjid;      // local index of the vobj containing the MWMR channel
233} mapping_cp_port_t;
234
235
236///////////////////////////////
237typedef struct mapping_periph_s {
238    unsigned int type;           // IOC / TTY / TIM / DMA / FBF / NIC / IOB
239    unsigned int psegid;         // pseg index in cluster
240    unsigned int channels;       // number of channels
241} mapping_periph_t;
242
243
244#endif
245
246// Local Variables:
247// tab-width: 4
248// c-basic-offset: 4
249// c-file-offsets:((innamespace . 0)(inline-open . 0))
250// indent-tabs-mode: nil
251// End:
252
253// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
254
Note: See TracBrowser for help on using the repository browser.