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

Last change on this file since 522 was 522, checked in by alain, 9 years ago

Simplification in the mapping_info.h file:
The coproc and cp_port objects have been removed,
because the coprocessors are now described as peripherals.

The xml parser and driver have been modified accordingly.
  • Property svn:executable set to *
File size: 11.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, 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).
11// The number of processors per cluster is variable (can be zero).
12// The number of peripherals per cluster is variable (can be zero),
13// The number of physical memory bank 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). Each vspace contains a variable number
18// of virtual segments (called vsegs).
19//
20// 3/ the mapping directives: both tasks on processors, and software objects
21// (vsegs) on the physical memory banks (psegs).
22//
23// The mapping_info data structure is organised as the concatenation of
24// a fixed size header, and 8 variable size arrays:
25//
26// - mapping_cluster_t  cluster[] 
27// - mapping_pseg_t     pseg[]       
28// - mapping_vspace_t   vspace[] 
29// - mapping_vseg_t     vseg[]     
30// - mapping_task_t     task[] 
31// - mapping_proc_t     proc[] 
32// - mapping_irq_t      irq[]   
33// - mapping_periph_t   periph[]
34//
35// It is intended to be stored in memory in the seg_boot_mapping segment.
36////////////////////////////////////////////////////////////////////////////
37
38#ifndef _MAPPING_INFO_H_
39#define _MAPPING_INFO_H_
40
41#define MAPPING_HEADER_SIZE   sizeof(mapping_header_t)
42#define MAPPING_CLUSTER_SIZE  sizeof(mapping_cluster_t)
43#define MAPPING_VSPACE_SIZE   sizeof(mapping_vspace_t)
44#define MAPPING_VSEG_SIZE     sizeof(mapping_vseg_t)
45#define MAPPING_PSEG_SIZE     sizeof(mapping_pseg_t)
46#define MAPPING_TASK_SIZE     sizeof(mapping_task_t)
47#define MAPPING_PROC_SIZE     sizeof(mapping_proc_t)
48#define MAPPING_IRQ_SIZE      sizeof(mapping_irq_t)
49#define MAPPING_PERIPH_SIZE   sizeof(mapping_periph_t)
50
51#define C_MODE_MASK  0b1000   // cacheable
52#define X_MODE_MASK  0b0100   // executable
53#define W_MODE_MASK  0b0010   // writable
54#define U_MODE_MASK  0b0001   // user access
55
56#define IN_MAPPING_SIGNATURE    0xDACE2014
57#define OUT_MAPPING_SIGNATURE   0xBABEF00D
58
59typedef unsigned long long  paddr_t;
60
61enum vsegType
62{
63    VSEG_TYPE_ELF      = 0,  // loadable code/data object of elf files
64    VSEG_TYPE_BLOB     = 1,  // loadable blob object
65    VSEG_TYPE_PTAB     = 2,  // page table
66    VSEG_TYPE_PERI     = 3,  // hardware component
67    VSEG_TYPE_MWMR     = 4,  // MWMR channel
68    VSEG_TYPE_LOCK     = 5,  // Lock
69    VSEG_TYPE_BUFFER   = 6,  // Any "no initialization" objects (stacks...)
70    VSEG_TYPE_BARRIER  = 7,  // Barrier
71    VSEG_TYPE_CONST    = 8,  // Constant
72    VSEG_TYPE_MEMSPACE = 9,  // Memspace (descriptor must be initialised)
73    VSEG_TYPE_SCHED    = 10, // Array of schedulers (one per cluster)
74    VSEG_TYPE_HEAP     = 11, // Heap   f schedulers (one per cluster)
75};
76
77enum irqType
78{
79    IRQ_TYPE_HWI = 0,        // HARD in map.xml file
80    IRQ_TYPE_WTI = 1,        // SOFT in map.xml file,
81    IRQ_TYPE_PTI = 2,        // TIME in map.xml file,
82};
83
84
85enum psegType
86{
87    PSEG_TYPE_RAM  = 0,
88    PSEG_TYPE_PERI = 2,
89};
90
91
92////////////////////////////////////////////////////////////////////
93// These enum must be coherent with the values in
94// xml_driver.c / xml_parser.c / mapping.py
95///////////////////////////////////////////////////////////////////
96enum periphTypes
97{
98    PERIPH_TYPE_CMA       = 0,
99    PERIPH_TYPE_DMA       = 1,
100    PERIPH_TYPE_FBF       = 2,
101    PERIPH_TYPE_IOB       = 3,
102    PERIPH_TYPE_IOC       = 4,
103    PERIPH_TYPE_MMC       = 5,
104    PERIPH_TYPE_MWR       = 6,
105    PERIPH_TYPE_NIC       = 7,
106    PERIPH_TYPE_ROM       = 8,
107    PERIPH_TYPE_SIM       = 9,
108    PERIPH_TYPE_TIM       = 10,
109    PERIPH_TYPE_TTY       = 11,
110    PERIPH_TYPE_XCU       = 12,
111    PERIPH_TYPE_PIC       = 13,
112    PERIPH_TYPE_DROM      = 14,
113
114    PERIPH_TYPE_MAX_VALUE = 15,
115};
116
117enum iocTypes
118{
119    IOC_SUBTYPE_BDV    = 0,
120    IOC_SUBTYPE_HBA    = 1,
121    IOC_SUBTYPE_SPI    = 2,
122    IOC_SUBTYPE_NONE   = 3,
123};
124
125enum mwrTypes
126{
127    MWR_SUBTYPE_GCD       = 0,
128    MWR_SUBTYPE_DCT       = 1,
129};
130
131//////////////////////////////////////////////////////////
132// This enum must be coherent with the values in
133// mwr_driver.h               
134//////////////////////////////////////////////////////////
135enum MwmrDmaModes
136{
137    MODE_MWMR             = 0,
138    MODE_DMA_IRQ          = 1,
139    MODE_DMA_NO_IRQ       = 2,
140};
141
142////////////////////////////////////////////////////////
143typedef struct __attribute__((packed))  mapping_header_s
144{
145    unsigned int signature;          // must contain IN_MAPPING_SIGNATURE
146    unsigned int x_size;             // actual number of clusters in a row
147    unsigned int y_size;             // actual number of clusters in a column
148    unsigned int x_width;            // number of bits to encode x coordinate
149    unsigned int y_width;            // number of bits to encode y coordinate
150    unsigned int x_io;               // x coordinate for cluster_io_ext
151    unsigned int y_io;               // y coordinate for cluster_io_ext
152    unsigned int irq_per_proc;       // number of IRQ per processor
153    unsigned int use_ram_disk;       // does not use IOC peripheral if non zero
154    unsigned int globals;            // total number of global vsegs
155    unsigned int vspaces;            // total number of virtual spaces
156    unsigned int psegs;              // total number of physical segments
157    unsigned int vsegs;              // total number of virtual segments
158    unsigned int tasks;              // total number of tasks
159    unsigned int procs;              // total number of processors
160    unsigned int irqs;               // total number of irqs
161    unsigned int periphs;            // total number of peripherals
162    char name[32];                   // mapping name
163} mapping_header_t;
164
165
166/////////////////////////////////////////////////////////
167typedef struct __attribute__((packed))  mapping_cluster_s
168{
169    unsigned int    x;               // x coordinate
170    unsigned int    y;               // y coordinate
171
172    unsigned int    psegs;           // number of psegs in cluster
173    unsigned int    pseg_offset;     // global index of first pseg in cluster
174
175    unsigned int    procs;           // number of processors in cluster
176    unsigned int    proc_offset;     // global index of first proc in cluster
177 
178    unsigned int    periphs;         // number of peripherals in cluster
179    unsigned int    periph_offset;   // global index of first coproc in cluster
180} mapping_cluster_t;
181
182
183////////////////////////////////////////////////////////
184typedef struct __attribute__((packed))  mapping_vspace_s
185{
186    char            name[32];        // virtual space name
187    unsigned int    start_vseg_id;   // vseg containing start vector index
188    unsigned int    vsegs;           // number of vsegs in vspace
189    unsigned int    tasks;           // number of tasks in vspace
190    unsigned int    vseg_offset;     // global index of first vseg in vspace
191    unsigned int    task_offset;     // global index of first task in vspace
192} mapping_vspace_t;
193
194
195//////////////////////////////////////////////////////
196typedef struct __attribute__((packed))  mapping_vseg_s
197{
198    char            name[32];        // vseg name (unique in vspace)
199    char            binpath[64];     // path for the binary code (if required)
200    unsigned int    vbase;           // base address in virtual space
201    paddr_t         pbase;           // base address in physical space
202    unsigned int    length;          // size (bytes)
203    unsigned int    psegid;          // physical segment global index
204    unsigned int    mode;            // C-X-W-U flags
205    unsigned int    type;            // vseg type
206    char            mapped;          // mapped if non zero
207    char            ident;           // identity mapping if non zero
208    char            local;           // only mapped in the local PTAB
209    char            big;             // to be mapped in a big physical page
210} mapping_vseg_t;
211
212
213//////////////////////////////////////////////////////
214typedef struct __attribute__((packed))  mapping_pseg_s 
215{
216    char            name[32];        // pseg name (unique in a cluster)
217    paddr_t         base;            // base address in physical space
218    paddr_t         length;          // size (bytes)
219    unsigned int    type;            // RAM / PERI
220    unsigned int    clusterid;       // global index in clusters set
221    unsigned int    next_vseg;       // linked list of vsegs mapped on pseg
222} mapping_pseg_t;
223
224
225//////////////////////////////////////////////////////
226typedef struct __attribute__((packed))  mapping_task_s
227{
228    char            name[32];        // task name (unique in vspace)
229    unsigned int    clusterid;       // global index in clusters set
230    unsigned int    proclocid;       // processor local index (inside cluster)
231    unsigned int    trdid;           // thread index in vspace
232    unsigned int    stack_vseg_id;   // global index for vseg containing stack
233    unsigned int    heap_vseg_id;    // global index for vseg containing heap
234    unsigned int    startid;         // index in start_vector
235} mapping_task_t;
236
237
238//////////////////////////////////////////////////////
239typedef struct __attribute__((packed))  mapping_proc_s
240{
241    unsigned int    index;           // processor local index (in cluster)
242} mapping_proc_t;
243
244
245////////////////////////////////////////////////////////
246typedef struct __attribute__((packed))  mapping_periph_s
247{
248    unsigned int    type;            // legal values defined above
249    unsigned int    subtype;         // periph specialization
250    unsigned int    psegid;          // pseg index in cluster
251    unsigned int    channels;        // number of channels
252    unsigned int    arg0;            // semantic depends on peripheral type
253    unsigned int    arg1;            // semantic depends on peripheral type
254    unsigned int    arg2;            // semantic depends on peripheral type
255    unsigned int    arg3;            // semantic depends on peripheral type
256    unsigned int    irqs;            // number of input IRQs (for XCU or PIC)
257    unsigned int    irq_offset;      // index of first IRQ
258} mapping_periph_t;
259
260
261/////////////////////////////////////////////////////
262typedef struct __attribute__((packed))  mapping_irq_s
263{
264    unsigned int    srctype;         // source IRQ type (HWI / WTI / PTI)
265    unsigned int    srcid;           // source IRQ index (for XCU/PIC component)
266    unsigned int    isr;             // ISR type (defined in irq_handler.h)
267    unsigned int    channel;         // channel index (for multi-channels ISR)
268    unsigned int    dest_xy;         // destination cluster (set by GIET_VM)
269    unsigned int    dest_id;         // destination port (set by GIET_VM)
270} mapping_irq_t; 
271
272
273#endif
274
275// Local Variables:
276// tab-width: 4
277// c-basic-offset: 4
278// c-file-offsets:((innamespace . 0)(inline-open . 0))
279// indent-tabs-mode: nil
280// End:
281
282// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
283
Note: See TracBrowser for help on using the repository browser.