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

Last change on this file since 608 was 566, checked in by alain, 10 years ago

Introducing support for a new IOC controller: IOC_SUBTYPE_SDC.
  • Property svn:executable set to *
File size: 10.8 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_BUFFER   = 4,  // no initialization object (stacks...)
68    VSEG_TYPE_SCHED    = 5,  // scheduler
69    VSEG_TYPE_HEAP     = 6,  // heap
70};
71
72enum irqType
73{
74    IRQ_TYPE_HWI = 0,        // HARD in map.xml file
75    IRQ_TYPE_WTI = 1,        // SOFT in map.xml file,
76    IRQ_TYPE_PTI = 2,        // TIME in map.xml file,
77};
78
79
80enum psegType
81{
82    PSEG_TYPE_RAM  = 0,
83    PSEG_TYPE_PERI = 2,
84};
85
86
87////////////////////////////////////////////////////////////////////
88// These enum must be coherent with the values in
89// xml_driver.c / xml_parser.c / mapping.py
90///////////////////////////////////////////////////////////////////
91enum periphTypes
92{
93    PERIPH_TYPE_CMA       = 0,
94    PERIPH_TYPE_DMA       = 1,
95    PERIPH_TYPE_FBF       = 2,
96    PERIPH_TYPE_IOB       = 3,
97    PERIPH_TYPE_IOC       = 4,
98    PERIPH_TYPE_MMC       = 5,
99    PERIPH_TYPE_MWR       = 6,
100    PERIPH_TYPE_NIC       = 7,
101    PERIPH_TYPE_ROM       = 8,
102    PERIPH_TYPE_SIM       = 9,
103    PERIPH_TYPE_TIM       = 10,
104    PERIPH_TYPE_TTY       = 11,
105    PERIPH_TYPE_XCU       = 12,
106    PERIPH_TYPE_PIC       = 13,
107    PERIPH_TYPE_DROM      = 14,
108
109    PERIPH_TYPE_MAX_VALUE = 15,
110};
111
112enum iocTypes
113{
114    IOC_SUBTYPE_BDV       = 0,
115    IOC_SUBTYPE_HBA       = 1,
116    IOC_SUBTYPE_SDC       = 2,
117    IOC_SUBTYPE_SPI       = 3,
118};
119
120enum mwrTypes
121{
122    MWR_SUBTYPE_GCD       = 0,
123    MWR_SUBTYPE_DCT       = 1,
124    MWR_SUBTYPE_CPY       = 2,
125};
126
127//////////////////////////////////////////////////////////
128// This enum must be coherent with the values in
129// mwr_driver.h               
130//////////////////////////////////////////////////////////
131enum MwmrDmaModes
132{
133    MODE_MWMR             = 0,
134    MODE_DMA_IRQ          = 1,
135    MODE_DMA_NO_IRQ       = 2,
136};
137
138////////////////////////////////////////////////////////
139typedef struct __attribute__((packed))  mapping_header_s
140{
141    unsigned int    signature;       // must contain IN_MAPPING_SIGNATURE
142    unsigned int    x_size;          // actual number of clusters in a row
143    unsigned int    y_size;          // actual number of clusters in a column
144    unsigned int    x_width;         // number of bits to encode x coordinate
145    unsigned int    y_width;         // number of bits to encode y coordinate
146    unsigned int    x_io;            // x coordinate for cluster_io_ext
147    unsigned int    y_io;            // y coordinate for cluster_io_ext
148    unsigned int    irq_per_proc;    // number of IRQ per processor
149    unsigned int    use_ram_disk;    // does not use IOC peripheral if non zero
150    unsigned int    globals;         // total number of global vsegs
151    unsigned int    vspaces;         // total number of virtual spaces
152    unsigned int    psegs;           // total number of physical segments
153    unsigned int    vsegs;           // total number of virtual segments
154    unsigned int    tasks;           // total number of tasks
155    unsigned int    procs;           // total number of processors
156    unsigned int    irqs;            // total number of irqs
157    unsigned int    periphs;         // total number of peripherals
158    char name[64];                   // mapping name
159} mapping_header_t;
160
161
162/////////////////////////////////////////////////////////
163typedef struct __attribute__((packed))  mapping_cluster_s
164{
165    unsigned int    x;               // x coordinate
166    unsigned int    y;               // y coordinate
167
168    unsigned int    psegs;           // number of psegs in cluster
169    unsigned int    pseg_offset;     // global index of first pseg in cluster
170
171    unsigned int    procs;           // number of processors in cluster
172    unsigned int    proc_offset;     // global index of first proc in cluster
173 
174    unsigned int    periphs;         // number of peripherals in cluster
175    unsigned int    periph_offset;   // global index of first coproc in cluster
176} mapping_cluster_t;
177
178
179////////////////////////////////////////////////////////
180typedef struct __attribute__((packed))  mapping_vspace_s
181{
182    char            name[32];        // virtual space name
183    unsigned int    start_vseg_id;   // vseg containing start vector index
184    unsigned int    vsegs;           // number of vsegs in vspace
185    unsigned int    tasks;           // number of tasks in vspace
186    unsigned int    vseg_offset;     // global index of first vseg in vspace
187    unsigned int    task_offset;     // global index of first task in vspace
188} mapping_vspace_t;
189
190
191//////////////////////////////////////////////////////
192typedef struct __attribute__((packed))  mapping_vseg_s
193{
194    char            name[32];        // vseg name (unique in vspace)
195    char            binpath[64];     // path for the binary code (if required)
196    unsigned int    vbase;           // base address in virtual space
197    paddr_t         pbase;           // base address in physical space
198    unsigned int    length;          // size (bytes)
199    unsigned int    psegid;          // physical segment global index
200    unsigned int    mode;            // C-X-W-U flags
201    unsigned int    type;            // vseg type
202    char            mapped;          // mapped if non zero
203    char            ident;           // identity mapping if non zero
204    char            local;           // only mapped in the local PTAB
205    char            big;             // to be mapped in a big physical page
206} mapping_vseg_t;
207
208
209//////////////////////////////////////////////////////
210typedef struct __attribute__((packed))  mapping_pseg_s 
211{
212    char            name[32];        // pseg name (unique in a cluster)
213    paddr_t         base;            // base address in physical space
214    paddr_t         length;          // size (bytes)
215    unsigned int    type;            // RAM / PERI
216    unsigned int    clusterid;       // global index in clusters set
217    unsigned int    next_vseg;       // linked list of vsegs mapped on pseg
218} mapping_pseg_t;
219
220
221//////////////////////////////////////////////////////
222typedef struct __attribute__((packed))  mapping_task_s
223{
224    char            name[32];        // task name (unique in vspace)
225    unsigned int    clusterid;       // global index in clusters set
226    unsigned int    proclocid;       // processor local index (inside cluster)
227    unsigned int    trdid;           // thread index in vspace
228    unsigned int    stack_vseg_id;   // global index for vseg containing stack
229    unsigned int    heap_vseg_id;    // global index for vseg containing heap
230    unsigned int    startid;         // index in start_vector
231} mapping_task_t;
232
233
234//////////////////////////////////////////////////////
235typedef struct __attribute__((packed))  mapping_proc_s
236{
237    unsigned int    index;           // processor local index (in cluster)
238} mapping_proc_t;
239
240
241////////////////////////////////////////////////////////
242typedef struct __attribute__((packed))  mapping_periph_s
243{
244    unsigned int    type;            // legal values defined above
245    unsigned int    subtype;         // periph specialization
246    unsigned int    psegid;          // pseg index in cluster
247    unsigned int    channels;        // number of channels
248    unsigned int    arg0;            // semantic depends on peripheral type
249    unsigned int    arg1;            // semantic depends on peripheral type
250    unsigned int    arg2;            // semantic depends on peripheral type
251    unsigned int    arg3;            // semantic depends on peripheral type
252    unsigned int    irqs;            // number of input IRQs (for XCU or PIC)
253    unsigned int    irq_offset;      // index of first IRQ
254} mapping_periph_t;
255
256
257/////////////////////////////////////////////////////
258typedef struct __attribute__((packed))  mapping_irq_s
259{
260    unsigned int    srctype;         // source IRQ type (HWI / WTI / PTI)
261    unsigned int    srcid;           // source IRQ index (for XCU/PIC)
262    unsigned int    isr;             // ISR type (defined in irq_handler.h)
263    unsigned int    channel;         // channel index (for multi-channels ISR)
264    unsigned int    dest_xy;         // destination cluster (set by GIET_VM)
265    unsigned int    dest_id;         // destination port (set by GIET_VM)
266} mapping_irq_t; 
267
268
269#endif
270
271// Local Variables:
272// tab-width: 4
273// c-basic-offset: 4
274// c-file-offsets:((innamespace . 0)(inline-open . 0))
275// indent-tabs-mode: nil
276// End:
277
278// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
279
Note: See TracBrowser for help on using the repository browser.