source: soft/giet_vm/giet_xml/mapping_info.h @ 337

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

ntroducing several modifs in the mapping_info data structure
to comply with the genmap tool.
  • Property svn:executable set to *
File size: 13.4 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, used by the GIET_VM kernel contains:
8//
9// 1) a description of a clusterized hardware architecture.
10// The number of cluster is variable (can be one). The number of processors
11// per cluster is variable (can be one). The number of peripherals per cluser
12// and coprocessor per cluster is variable. The number of physical memory
13// banks per cluster is variable.
14//
15// 2/ a description of the applications (called vspaces) to be - statically -
16// launched on the platform. The number of parallel tasks per application is
17// variable (can be one). Multi-Writer/Multi-Reader communication channels
18// betwwen tasks are supported. Each vspace contains a variable number
19// of virtual segments (called vsegs).
20//
21// 3/ the mapping directives: both tasks on processors, and software objects
22// (vobjs and vsegs) on the physical memory banks (called psegs).
23// and a variable number of tasks. The number of virtual space can be one.
24//
25// The mapping_info data structure is organised as the concatenation of
26// a fixed size header, and 11 variable size arrays:
27//
28// - mapping_cluster_t  cluster[] 
29// - mapping_pseg_t     pseg[]       
30// - mapping_vspace_t   vspace[] 
31// - mapping_vseg_t     vseg[]     
32// - mapping_vobj_t     vobj[]   
33// - mapping_task_t     task[] 
34// - mapping_proc_t     proc[] 
35// - mapping_irq_t      irq[]   
36// - mapping_coproc_t   coproc[]
37// - mapping_cp_port_t  cp_port[]
38// - mapping_periph_t   periph[]
39//
40// It is intended to be stored in memory in the seg_boot_mapping segment.
41////////////////////////////////////////////////////////////////////////////
42
43#ifndef _MAPPING_INFO_H_
44#define _MAPPING_INFO_H_
45
46#define MAPPING_HEADER_SIZE   sizeof(mapping_header_t)
47#define MAPPING_CLUSTER_SIZE  sizeof(mapping_cluster_t)
48#define MAPPING_VSPACE_SIZE   sizeof(mapping_vspace_t)
49#define MAPPING_VSEG_SIZE     sizeof(mapping_vseg_t)
50#define MAPPING_VOBJ_SIZE     sizeof(mapping_vobj_t)
51#define MAPPING_PSEG_SIZE     sizeof(mapping_pseg_t)
52#define MAPPING_TASK_SIZE     sizeof(mapping_task_t)
53#define MAPPING_PROC_SIZE     sizeof(mapping_proc_t)
54#define MAPPING_IRQ_SIZE      sizeof(mapping_irq_t)
55#define MAPPING_COPROC_SIZE   sizeof(mapping_coproc_t)
56#define MAPPING_CP_PORT_SIZE  sizeof(mapping_cp_port_t)
57
58#define C_MODE_MASK  0b1000   // cacheable
59#define X_MODE_MASK  0b0100   // executable
60#define W_MODE_MASK  0b0010   // writable
61#define U_MODE_MASK  0b0001   // user access
62
63#define IN_MAPPING_SIGNATURE    0xDACE2014
64#define OUT_MAPPING_SIGNATURE   0xBABEF00D
65
66typedef unsigned long long  paddr_t;
67
68enum vobjType
69{
70    VOBJ_TYPE_ELF      = 0,  // loadable code/data object of elf files
71    VOBJ_TYPE_BLOB     = 1,  // loadable blob object
72    VOBJ_TYPE_PTAB     = 2,  // page table
73    VOBJ_TYPE_PERI     = 3,  // hardware component
74    VOBJ_TYPE_MWMR     = 4,  // MWMR channel
75    VOBJ_TYPE_LOCK     = 5,  // Lock
76    VOBJ_TYPE_BUFFER   = 6,  // Any "no initialization" objects (stacks...)
77    VOBJ_TYPE_BARRIER  = 7,  // Barrier
78    VOBJ_TYPE_CONST    = 8,  // Constant
79    VOBJ_TYPE_MEMSPACE = 9,  // Memspace (descriptor must be initialised)
80    VOBJ_TYPE_SCHED    = 10, // Array of schedulers (one per cluster)
81};
82
83enum irqType
84{
85    IRQ_TYPE_HWI = 0,        // HARD in map.xml file
86    IRQ_TYPE_WTI = 1,        // SOFT in map.xml file,
87    IRQ_TYPE_PTI = 2,        // TIME in map.xml file,
88};
89
90enum psegType
91{
92    PSEG_TYPE_RAM  = 0,
93    PSEG_TYPE_ROM  = 1,      // deprecated => you should use PSEG_TYPE_PERI 
94    PSEG_TYPE_PERI = 2,
95};
96
97// The enum definitions for psegType and periphType must be kept
98// consistent with the definitions in the xml_driver.c file...
99
100enum periphType
101{
102    PERIPH_TYPE_CMA       = 0,
103    PERIPH_TYPE_DMA       = 1,
104    PERIPH_TYPE_FBF       = 2,
105    PERIPH_TYPE_ICU       = 3,
106    PERIPH_TYPE_IOB       = 4,
107    PERIPH_TYPE_IOC       = 5,
108    PERIPH_TYPE_MMC       = 6,
109    PERIPH_TYPE_MWR       = 7,
110    PERIPH_TYPE_NIC       = 8,
111    PERIPH_TYPE_ROM       = 9,
112    PERIPH_TYPE_SIM       = 10,
113    PERIPH_TYPE_TIM       = 11,
114    PERIPH_TYPE_TTY       = 12,
115    PERIPH_TYPE_XCU       = 13,
116    PERIPH_TYPE_PIC       = 14,
117
118    PERIPH_TYPE_MAX_VALUE = 15,
119};
120
121enum periphSubtype
122{
123    PERIPH_SUBTYPE_BDV       = 0,
124    PERIPH_SUBTYPE_HBA       = 1,
125    PERIPH_SUBTYPE_SPI       = 2,
126    PERIPH_SUBTYPE_NONE      = 3,
127};
128
129enum mwmrPortDirection
130{
131    PORT_TO_COPROC   = 0, // status register
132    PORT_FROM_COPROC = 1, // config register
133};
134
135
136////////////////////////////////////////////////////////
137typedef struct __attribute__((packed))  mapping_header_s
138{
139    unsigned int signature;          // must contain IN_MAPPING_SIGNATURE
140    unsigned int x_size;             // actual number of clusters in a row
141    unsigned int y_size;             // actual number of clusters in a column
142    unsigned int x_width;            // number of bits to encode x coordinate
143    unsigned int y_width;            // number of bits to encode y coordinate
144    unsigned int x_io;               // x coordinate for cluster_io_ext
145    unsigned int y_io;               // y coordinate for cluster_io_ext
146    unsigned int irq_per_proc;       // number of IRQ per processor
147    unsigned int use_ram_disk;       // does not use IOC peripheral if non zero
148    unsigned int globals;            // total number of global vsegs
149    unsigned int vspaces;            // total number of virtual spaces
150    unsigned int psegs;              // total number of physical segments (for all clusters)
151    unsigned int vsegs;              // total number of virtual segments (for all vspaces)
152    unsigned int vobjs;              // total number of virtual objects (for all vspaces)
153    unsigned int tasks;              // total number of tasks (for all vspaces)
154    unsigned int procs;              // total number of procs (for all clusters)
155    unsigned int irqs;               // total number of irqs (for all processors)
156    unsigned int coprocs;            // total number of coprocs (for all clusters)
157    unsigned int cp_ports;           // total number of cp_ports (for all coprocs)
158    unsigned int periphs;            // total number of peripherals (for all clusters)
159
160    char name[32];                   // mapping name
161} mapping_header_t;
162
163
164/////////////////////////////////////////////////////////
165typedef struct __attribute__((packed))  mapping_cluster_s
166{
167    unsigned int    x;               // x coordinate
168    unsigned int    y;               // y coordinate
169
170    unsigned int    psegs;           // number of psegs in cluster
171    unsigned int    pseg_offset;     // global index of first pseg in psegs set
172
173    unsigned int    procs;           // number of processors in cluster
174    unsigned int    proc_offset;     // global index of first proc in procs set
175 
176    unsigned int    coprocs;         // number of coprocessors in cluster
177    unsigned int    coproc_offset;   // global index of first coproc in coprocs set
178
179    unsigned int    periphs;         // number of peripherals in cluster
180    unsigned int    periph_offset;   // global index of first coproc in periphs set
181} mapping_cluster_t;
182
183
184////////////////////////////////////////////////////////
185typedef struct __attribute__((packed))  mapping_vspace_s
186{
187    char            name[32];        // virtual space name
188    unsigned int    start_vobj_id;   // global index for vobj containing start vector
189    unsigned int    vsegs;           // number of vsegs in vspace
190    unsigned int    vobjs;           // number of vobjs in vspace
191    unsigned int    tasks;           // number of tasks in vspace
192    unsigned int    vseg_offset;     // global index of first vseg in vspace
193    unsigned int    vobj_offset;     // global index of first vobj in vspace
194    unsigned int    task_offset;     // global index of first task in vspace
195} mapping_vspace_t;
196
197
198//////////////////////////////////////////////////////
199typedef struct __attribute__((packed))  mapping_vseg_s
200{
201    char            name[32];        // vseg name (unique in vspace)
202    unsigned int    vbase;           // base address in virtual space
203    paddr_t         pbase;           // base address in physical space
204    unsigned int    length;          // size (bytes)
205    unsigned int    psegid;          // physical segment global index
206    unsigned int    mode;            // C-X-W-U flags
207    unsigned int    vobjs;           // number of vobjs in vseg
208    unsigned int    vobj_offset;     // global index of first vobj in vseg
209    unsigned int    next_vseg;       // linked list of vsegs mapped on pseg
210    char            mapped;          // mapped if non zero
211    char            ident;           // identity mapping if non zero
212    char            rsvd0;           // reserved
213    char            rsvd1;           // reserved
214} mapping_vseg_t;
215
216
217//////////////////////////////////////////////////////
218typedef struct __attribute__((packed))  mapping_pseg_s 
219{
220    char            name[32];        // pseg name (unique in a cluster)
221    paddr_t         base;            // base address in physical space
222    paddr_t         length;          // size (bytes)
223    unsigned int    type;            // RAM / PERI
224    unsigned int    clusterid;       // global index in clusters set
225    unsigned int    next_vseg;       // linked list of vsegs mapped on pseg
226} mapping_pseg_t;
227
228
229//////////////////////////////////////////////////////
230typedef struct __attribute__((packed))  mapping_task_s
231{
232    char            name[32];        // task name (unique in vspace)
233    unsigned int    clusterid;       // global index in clusters set
234    unsigned int    proclocid;       // processor local index (inside cluster)
235    unsigned int    trdid;           // thread index in vspace
236    unsigned int    stack_vobj_id;   // global index for vobj containing stack
237    unsigned int    heap_vobj_id;    // global index for vobj containing heap
238    unsigned int    startid;         // index in start_vector
239    unsigned int    use_tty;         // TTY channel required (global)
240    unsigned int    use_nic;         // NIC channel required (global)
241    unsigned int    use_cma;         // CMA channel required (global)
242    unsigned int    use_hba;         // IOC channel required (global)
243    unsigned int    use_tim;         // user timer required (local)
244} mapping_task_t;
245
246
247//////////////////////////////////////////////////////
248typedef struct __attribute__((packed))  mapping_vobj_s
249{
250    char            name[32];        // vobj name (unique in a vspace)
251    char            binpath[64];     // path for the binary code ("*.elf")
252    unsigned int    type;            // type of vobj
253    unsigned int    length;          // size (bytes)
254    unsigned int    align;           // required alignement (logarithm of 2)
255    unsigned int    vaddr;           // virtual base addresse of the vobj
256    paddr_t         paddr;           // physical base addresse of the vobj
257    unsigned int    init;            // init value (used by barrier or mwmr channel)
258} mapping_vobj_t;
259
260
261//////////////////////////////////////////////////////
262typedef struct __attribute__((packed))  mapping_proc_s
263{
264    unsigned int    index;           // processor local index (in cluster)
265} mapping_proc_t;
266
267
268////////////////////////////////////////////////////////
269typedef struct __attribute__((packed))  mapping_coproc_s
270{
271    char            name[32];        // coprocessor name (probablement inutile AG)
272    unsigned int    psegid;          // global pseg index
273    unsigned int    ports;           // number of MWMR ports used by coprocessor
274    unsigned int    port_offset;     // global index of first MWMR port
275} mapping_coproc_t;
276
277
278/////////////////////////////////////////////////////////
279typedef struct __attribute__((packed))  mapping_cp_port_s
280{
281    unsigned int    direction;       // TO_COPROC == 0 / FROM_COPROC == 1
282    unsigned int    vspaceid;        // index of the vspace containing MWMR channel
283    unsigned int    mwmr_vobj_id;    // global index of vobj containing MWMR channel
284} mapping_cp_port_t;
285
286
287////////////////////////////////////////////////////////
288typedef struct __attribute__((packed))  mapping_periph_s
289{
290    unsigned int    type;            // legal values defined above
291    unsigned int    subtype;         // periph specialization
292    unsigned int    psegid;          // pseg index in cluster
293    unsigned int    channels;        // number of channels
294    unsigned int    arg;             // argument depending on peripheral type
295    unsigned int    irqs;            // number of input IRQs (for XCU or PIC)
296    unsigned int    irq_offset;      // index of first IRQ
297} mapping_periph_t;
298
299
300/////////////////////////////////////////////////////
301typedef struct __attribute__((packed))  mapping_irq_s
302{
303    unsigned int    srctype;         // source IRQ type (HWI / WTI / PTI)
304    unsigned int    srcid;           // source IRQ index (for XCU/PIC component)
305    unsigned int    isr;             // ISR type (defined in irq_handler.h)
306    unsigned int    channel;         // channel index (for multi-channels ISR)
307    unsigned int    dest_xy;         // destination cluster (set by GIET_VM)
308    unsigned int    dest_id;         // destination port (set by GIET_VM)
309} mapping_irq_t; 
310
311
312#endif
313
314// Local Variables:
315// tab-width: 4
316// c-basic-offset: 4
317// c-file-offsets:((innamespace . 0)(inline-open . 0))
318// indent-tabs-mode: nil
319// End:
320
321// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
322
Note: See TracBrowser for help on using the repository browser.