source: trunk/platforms/tsar_generic_iob/arch.py

Last change on this file was 1050, checked in by alain, 7 years ago

Introduce the vci_master_nic component in the TSAR IOB architecture.

  • Property svn:executable set to *
File size: 20.4 KB
Line 
1#!/usr/bin/env python
2
3from math import log, ceil
4from mapping import *
5
6##################################################################################
7#   file   : arch.py  (for the tsar_generic_iob architecture)
8#   date   : may 2014
9#   author : Alain Greiner
10##################################################################################
11#  This file contains a mapping generator for the "tsar_generic_iob" platform.
12#  This includes both the hardware architecture (clusters, processors, peripherals,
13#  physical space segmentation) and the mapping of all boot and kernel objects
14#  (global vsegs).
15#
16#  This platform includes 7 external peripherals, accessible through an IOB
17#  components located in cluster [0,0] or in cluster [x_size-1, y_size-1].
18#  Available peripherals are: TTY, IOC, FBF, ROM, NIC, CMA, PIC.
19#
20#  All clusters contain (nb_procs) processors, one L2 cache, one XCU, and
21#  one optional hardware coprocessor connected to a MWMR_DMA controller.
22#
23#  The "constructor" parameters (defined in Makefile) are:
24#  - x_size         : number of clusters in a row
25#  - y_size         : number of clusters in a column
26#  - nb_procs       : number of processors per cluster
27#  - nb_ttys        : number of TTY channels
28#  - fbf_width      : frame_buffer width = frame_buffer heigth
29#  - ioc_type       : can be 'BDV','HBA','SDC', 'SPI' but not 'RDK'
30#  - mwr_type       : coprocessor type / can be 'GCD','DCT','CPY','NONE'
31#
32#  The other hardware parameters (defined in this script) are:
33#  - nb_nics        : number of NIC channels
34#  - nb_cmas        : number of CMA channels
35#  - x_io           : cluster_io x coordinate
36#  - y_io           : cluster_io y coordinate
37#  - x_width        : number of bits for x coordinate
38#  - y_width        : number of bits for y coordinate
39#  - p_width        : number of bits for processor local index
40#  - paddr_width    : number of bits for physical address
41#  - irq_per_proc   : number of input IRQs per processor
42#  - peri_increment : address increment for replicated peripherals
43#
44#  Regarding the boot and kernel vsegs mapping :
45#  - We use one big physical page (2 Mbytes) for the preloader,
46#    the 4 boot vsegs are packed in one BPP allocated in cluster[0,0].
47#  - We use one BPP per cluster for the replicated kernel code vsegs.
48#  - We use one BPP in cluster[0][0] for the kernel data vseg.
49#  - We use two BPP per cluster for the distributed kernel heap vsegs.
50#  - We use one BPP per cluster for the distributed ptab vsegs.
51#  - We use two SPP per cluster for each schedulers.
52#  - We use one PBB for each external peripheral in IO cluster,
53#  - We use one SPP per cluster for each internal peripheral.
54##################################################################################
55
56########################
57def arch( x_size    = 2,
58          y_size    = 2,
59          nb_procs  = 2,
60          nb_ttys   = 1,
61          fbf_width = 128,
62          ioc_type  = 'BDV',
63          mwr_type  = 'CPY' ):
64
65    ### define architecture constants
66
67    if   ( x_size * y_size >= 4 ) : nb_nics = 4 
68    elif ( x_size * y_size == 2 ) : nb_nics = 2
69    else                          : nb_nics = 1
70
71    nb_cmas         = 1
72    x_io            = 0
73    y_io            = 0
74    x_width         = 4
75    y_width         = 4
76    p_width         = 4
77    paddr_width     = 40
78    irq_per_proc    = 4         
79    peri_increment  = 0x10000 
80
81    ### constructor parameters checking
82
83    assert( nb_procs <= (1 << p_width) )
84
85    assert( (x_size == 1) or (x_size == 2) or (x_size == 4)
86             or (x_size == 8) or (x_size == 16) )
87
88    assert( (y_size == 1) or (y_size == 2) or (y_size == 4)
89             or (y_size == 8) or (y_size == 16) )
90
91    assert( (nb_ttys >= 1) and (nb_ttys <= 16) )
92
93    assert( ((x_io == 0) and (y_io == 0)) or
94            ((x_io == x_size-1) and (y_io == y_size-1)) )
95
96    assert( ioc_type in [ 'BDV' , 'HBA' , 'SDC' , 'SPI' ] )
97
98    assert( mwr_type in [ 'GCD' , 'DCT' , 'CPY' ] )
99 
100    ### define platform name
101
102    platform_name = 'tsar_iob_%d_%d_%d' % ( x_size, y_size , nb_procs )
103    platform_name += '_%d_%d_%s_%s' % ( fbf_width , nb_ttys , ioc_type , mwr_type )
104
105    ### define physical segments replicated in all clusters
106
107    ram_base = 0x0000000000
108    ram_size = 0x4000000                   # 64 Mbytes
109
110    xcu_base = 0x00B0000000
111    xcu_size = 0x1000                      # 4 Kbytes
112
113    mwr_base = 0x00B1000000
114    mwr_size = 0x1000                      # 4 Kbytes
115
116    mmc_base = 0x00B2000000
117    mmc_size = 0x1000                      # 4 Kbytes
118
119    ### define physical segments for external peripherals
120    ## These segments are only defined in cluster_io
121
122    ioc_base  = 0x00B3000000
123    ioc_size  = 0x1000                     # 4 Kbytes
124
125    tty_base  = 0x00B4000000
126    tty_size  = 0x4000                     # 16 Kbytes
127
128    nic_base  = 0x00B5000000
129    nic_size  = 0x1000                     # 4 Kkbytes
130
131    cma_base  = 0x00B6000000
132    cma_size  = 0x1000 * nb_cmas           # 4 kbytes * nb_cmas
133
134    fbf_base  = 0x00B7000000
135    fbf_size  = fbf_width * fbf_width      # fbf_width * fbf_width bytes
136
137    pic_base  = 0x00B8000000
138    pic_size  = 0x1000                     # 4 Kbytes
139
140    iob_base  = 0x00BE000000
141    iob_size  = 0x1000                     # 4 bytes
142
143    rom_base  = 0x00BFC00000
144    rom_size  = 0x4000                     # 16 Kbytes
145
146    ### define  bootloader vsegs base addresses and sizes
147    ### We want to pack these 4 vsegs in 2 big pages
148    ### => boot cost two BIG pages in cluster[0][0]
149
150    boot_mapping_vbase   = 0x00000000           # ident
151    boot_mapping_size    = 0x00100000           # 1 Mbytes
152
153    boot_code_vbase      = 0x00100000           # ident
154    boot_code_size       = 0x00080000           # 512 Kbytes
155
156    boot_stack_vbase     = 0x00180000           # ident
157    boot_stack_size      = 0x00080000           # 512 Kbytes
158
159    boot_data_vbase      = 0x00200000           # ident
160    boot_data_size       = 0x00200000           # 2 Mbytes
161
162    ### define kernel vsegs base addresses and sizes
163    ### code, init, ptab, heap & sched vsegs are replicated in all clusters.
164    ### data & uncdata vsegs are only mapped in cluster[0][0].
165
166    kernel_code_vbase    = 0x80000000
167    kernel_code_size     = 0x00200000           # 2 Mbytes per cluster
168
169    kernel_data_vbase    = 0x90000000
170    kernel_data_size     = 0x00200000           # 2 Mbytes in cluster[0,0]
171
172    kernel_ptab_vbase    = 0xE0000000
173    kernel_ptab_size     = 0x00200000           # 2 Mbytes per cluster
174
175    kernel_heap_vbase    = 0xD0000000
176    kernel_heap_size     = 0x00200000           # 2 Mbytes per cluster
177
178    kernel_sched_vbase   = 0xA0000000   
179    kernel_sched_size    = 0x00002000*nb_procs  # 8 Kbytes per proc per cluster
180
181    #########################
182    ### create mapping
183    #########################
184
185    mapping = Mapping( name           = platform_name, 
186                       x_size         = x_size,       
187                       y_size         = y_size,       
188                       nprocs         = nb_procs,     
189                       x_width        = x_width,       
190                       y_width        = y_width,       
191                       p_width        = p_width,
192                       paddr_width    = paddr_width,   
193                       coherence      = True,         
194                       irq_per_proc   = irq_per_proc, 
195                       use_ramdisk    = (ioc_type == 'RDK'),
196                       x_io           = x_io,         
197                       y_io           = y_io,
198                       peri_increment = peri_increment,
199                       ram_base       = ram_base,
200                       ram_size       = ram_size )
201
202
203    #############################
204    ###   Hardware Components
205    #############################
206
207    for x in xrange( x_size ):
208        for y in xrange( y_size ):
209            cluster_xy = (x << y_width) + y;
210            offset     = cluster_xy << (paddr_width - x_width - y_width)
211
212            ### components replicated in all clusters
213            mapping.addRam( 'RAM', base = ram_base + offset, 
214                                  size = ram_size )
215
216            xcu = mapping.addPeriph( 'XCU', base = xcu_base + offset, 
217                                     size = xcu_size, ptype = 'XCU', 
218                                     channels = nb_procs * irq_per_proc, 
219                                     arg0 = 32, arg1 = 32, arg2 = 32 )
220
221            mmc = mapping.addPeriph( 'MMC', base = mmc_base + offset,
222                                     size = mmc_size, ptype = 'MMC' )
223
224            if ( mwr_type == 'GCD' ):
225                mwr = mapping.addPeriph( 'MWR', base = mwr_base + offset,
226                                         size = mwr_size, ptype = 'MWR', subtype = 'GCD',
227                                         arg0 = 2, arg1 = 1, arg2 = 1, arg3 = 0 )
228
229            if ( mwr_type == 'DCT' ):
230                mwr = mapping.addPeriph( 'MWR', base = mwr_base + offset,
231                                         size = mwr_size, ptype = 'MWR', subtype = 'DCT',
232                                         arg0 = 1, arg1 = 1, arg2 = 1, arg3 = 0 )
233
234            if ( mwr_type == 'CPY' ):
235                mwr = mapping.addPeriph( 'MWR', base = mwr_base + offset,
236                                         size = mwr_size, ptype = 'MWR', subtype = 'CPY',
237                                         arg0 = 1, arg1 = 1, arg2 = 1, arg3 = 0 )
238
239            mapping.addIrq( xcu, index = 0, src = mmc, isrtype = 'ISR_MMC' )
240            mapping.addIrq( xcu, index = 1, src = mwr, isrtype = 'ISR_MWR' )
241
242            for p in xrange ( nb_procs ):
243                mapping.addProc( x , y , p )
244
245            ### external peripherals in cluster_io
246            if ( (x==x_io) and (y==y_io) ):
247
248                iob = mapping.addPeriph( 'IOB', base = iob_base + offset, size = iob_size, 
249                                         ptype = 'IOB' )
250
251                ioc = mapping.addPeriph( 'IOC', base = ioc_base + offset, size = ioc_size, 
252                                         ptype = 'IOC', subtype = ioc_type )
253
254                tty = mapping.addPeriph( 'TTY', base = tty_base + offset, size = tty_size, 
255                                         ptype = 'TTY', channels = nb_ttys )
256
257                nic = mapping.addPeriph( 'NIC', base = nic_base + offset, size = nic_size, 
258                                         ptype = 'NIC', channels = nb_nics )
259
260                cma = mapping.addPeriph( 'CMA', base = cma_base + offset, size = cma_size, 
261                                         ptype = 'CMA', channels = nb_cmas )
262
263                fbf = mapping.addPeriph( 'FBF', base = fbf_base + offset, size = fbf_size, 
264                                         ptype = 'FBF', arg0 = fbf_width, arg1 = fbf_width )
265
266                rom = mapping.addPeriph( 'ROM', base = rom_base + offset, size = rom_size, 
267                                         ptype = 'ROM' )
268
269                pic = mapping.addPeriph( 'PIC', base = pic_base + offset, size = pic_size, 
270                                         ptype = 'PIC', channels = 32 )
271
272                if ( ioc_type == 'BDV' ): isr_ioc = 'ISR_BDV'
273                if ( ioc_type == 'HBA' ): isr_ioc = 'ISR_HBA'
274                if ( ioc_type == 'SDC' ): isr_ioc = 'ISR_SDC'
275                if ( ioc_type == 'SPI' ): isr_ioc = 'ISR_SPI'
276
277                mapping.addIrq( pic, index = 0, src = nic,
278                                isrtype = 'ISR_NIC_RX', channel = 0 )
279                mapping.addIrq( pic, index = 1, src = nic,
280                                isrtype = 'ISR_NIC_RX', channel = 1 )
281                mapping.addIrq( pic, index = 2, src = nic,
282                                isrtype = 'ISR_NIC_RX', channel = 2 )
283                mapping.addIrq( pic, index = 3, src = nic,
284                                isrtype = 'ISR_NIC_RX', channel = 3 )
285
286                mapping.addIrq( pic, index = 4, src = nic,
287                                isrtype = 'ISR_NIC_TX', channel = 0 )
288                mapping.addIrq( pic, index = 5, src = nic,
289                                isrtype = 'ISR_NIC_TX', channel = 1 )
290                mapping.addIrq( pic, index = 6, src = nic,
291                                isrtype = 'ISR_NIC_TX', channel = 2 )
292                mapping.addIrq( pic, index = 7, src = nic,
293                                isrtype = 'ISR_NIC_TX', channel = 3 )
294
295                mapping.addIrq( pic, index = 8 , src = cma,
296                                isrtype = 'ISR_CMA', channel = 0 )
297                mapping.addIrq( pic, index = 9 , src = cma,
298                                isrtype = 'ISR_CMA', channel = 1 )
299                mapping.addIrq( pic, index = 10, src = cma,
300                                isrtype = 'ISR_CMA', channel = 2 )
301                mapping.addIrq( pic, index = 11, src = cma,
302                                isrtype = 'ISR_CMA', channel = 3 )
303
304                mapping.addIrq( pic, index = 12, src = ioc,
305                                isrtype = isr_ioc, channel = 0 )
306
307                mapping.addIrq( pic, index = 16, src = tty,
308                                isrtype = 'ISR_TTY_RX', channel = 0 )
309                mapping.addIrq( pic, index = 17, src = tty,
310                                isrtype = 'ISR_TTY_RX', channel = 1 )
311                mapping.addIrq( pic, index = 18, src = tty,
312                                isrtype = 'ISR_TTY_RX', channel = 2 )
313                mapping.addIrq( pic, index = 19, src = tty,
314                                isrtype = 'ISR_TTY_RX', channel = 3 )
315                mapping.addIrq( pic, index = 20, src = tty,
316                                isrtype = 'ISR_TTY_RX', channel = 4 )
317                mapping.addIrq( pic, index = 21, src = tty,
318                                isrtype = 'ISR_TTY_RX', channel = 5 )
319                mapping.addIrq( pic, index = 22, src = tty,
320                                isrtype = 'ISR_TTY_RX', channel = 6 )
321                mapping.addIrq( pic, index = 23, src = tty,
322                                isrtype = 'ISR_TTY_RX', channel = 7 )
323
324
325    ####################################
326    ###   Boot & Kernel vsegs mapping
327    ####################################
328
329    ### global vsegs for boot_loader
330    ### we want to pack those 4 vsegs in the same big page
331    ### => same flags CXW_ / identity mapping / non local / big page
332
333    mapping.addGlobal( 'seg_boot_mapping', boot_mapping_vbase, boot_mapping_size,
334                       'CXW_', vtype = 'BLOB'  , x = 0, y = 0, pseg = 'RAM',
335                       identity = True , local = False, big = True )
336
337    mapping.addGlobal( 'seg_boot_code', boot_code_vbase, boot_code_size,
338                       'CXW_', vtype = 'BUFFER', x = 0, y = 0, pseg = 'RAM',
339                       identity = True , local = False, big = True )
340
341    mapping.addGlobal( 'seg_boot_data', boot_data_vbase, boot_data_size,
342                       'CXW_', vtype = 'BUFFER', x = 0, y = 0, pseg = 'RAM',
343                       identity = True , local = False, big = True )
344
345    mapping.addGlobal( 'seg_boot_stack', boot_stack_vbase, boot_stack_size,
346                       'CXW_', vtype = 'BUFFER', x = 0, y = 0, pseg = 'RAM',
347                       identity = True , local = False, big = True )
348
349    ### global vseg kernel_data : big / non local
350    ### Only mapped in cluster[0][0]
351    mapping.addGlobal( 'seg_kernel_data', kernel_data_vbase, kernel_data_size, 
352                       'CXW_', vtype = 'ELF', x = 0, y = 0, pseg = 'RAM', 
353                       binpath = 'bin/kernel/kernel.elf', 
354                       local = False, big = True )
355
356    ### global vsegs kernel_code : big / local
357    ### replicated in all clusters with indexed name & same vbase
358    for x in xrange( x_size ):
359        for y in xrange( y_size ):
360            mapping.addGlobal( 'seg_kernel_code_%d_%d' %(x,y), 
361                               kernel_code_vbase, kernel_code_size,
362                               'CXW_', vtype = 'ELF', x = x , y = y , pseg = 'RAM',
363                               binpath = 'bin/kernel/kernel.elf', 
364                               local = True, big = True )
365
366    ### Global vsegs kernel_ptab_x_y : big / non local
367    ### one vseg per cluster: name indexed by (x,y)
368    for x in xrange( x_size ):
369        for y in xrange( y_size ):
370            offset = ((x << y_width) + y) * kernel_ptab_size
371            base   = kernel_ptab_vbase + offset
372            mapping.addGlobal( 'seg_kernel_ptab_%d_%d' %(x,y), base, kernel_ptab_size,
373                               'CXW_', vtype = 'PTAB', x = x, y = y, pseg = 'RAM', 
374                               local = False , big = True )
375
376    ### global vsegs kernel_sched_x_y : small / non local
377    ### one vseg per cluster with name indexed by (x,y)
378    for x in xrange( x_size ):
379        for y in xrange( y_size ):
380            offset = ((x << y_width) + y) * kernel_sched_size
381            mapping.addGlobal( 'seg_kernel_sched_%d_%d' %(x,y), 
382                               kernel_sched_vbase + offset , kernel_sched_size,
383                               'C_W_', vtype = 'SCHED', x = x , y = y , pseg = 'RAM',
384                               local = False, big = False )
385
386    ### global vsegs kernel_heap_x_y : big / non local
387    ### one vseg per cluster with name indexed by (x,y)
388    for x in xrange( x_size ):
389        for y in xrange( y_size ):
390            offset = ((x << y_width) + y) * kernel_heap_size
391            mapping.addGlobal( 'seg_kernel_heap_%d_%d' %(x,y), 
392                               kernel_heap_vbase + offset , kernel_heap_size,
393                               'C_W_', vtype = 'HEAP', x = x , y = y , pseg = 'RAM',
394                               local = False, big = True )
395
396    ### global vsegs for external peripherals : non local / big page
397    mapping.addGlobal( 'seg_iob', iob_base, iob_size, '__W_',
398                       vtype = 'PERI', x = 0, y = 0, pseg = 'IOB',
399                       local = False, big = True )
400
401    mapping.addGlobal( 'seg_ioc', ioc_base, ioc_size, '__W_',
402                       vtype = 'PERI', x = 0, y = 0, pseg = 'IOC',
403                       local = False, big = True )
404
405    mapping.addGlobal( 'seg_tty', tty_base, tty_size, '__W_',
406                       vtype = 'PERI', x = 0, y = 0, pseg = 'TTY',
407                       local = False, big = True )
408
409    mapping.addGlobal( 'seg_nic', nic_base, nic_size, '__W_',
410                       vtype = 'PERI', x = 0, y = 0, pseg = 'NIC',
411                       local = False, big = True )
412
413    mapping.addGlobal( 'seg_cma', cma_base, cma_size, '__W_',
414                       vtype = 'PERI', x = 0, y = 0, pseg = 'CMA',
415                       local = False, big = True )
416
417    mapping.addGlobal( 'seg_fbf', fbf_base, fbf_size, '__W_',
418                       vtype = 'PERI', x = 0, y = 0, pseg = 'FBF',
419                       local = False, big = True )
420
421    mapping.addGlobal( 'seg_pic', pic_base, pic_size, '__W_',
422                       vtype = 'PERI', x = 0, y = 0, pseg = 'PIC',
423                       local = False, big = True )
424
425    mapping.addGlobal( 'seg_rom', rom_base, rom_size, 'CXW_',
426                       vtype = 'PERI', x = 0, y = 0, pseg = 'ROM',
427                       local = False, big = True )
428
429    ### global vsegs for internal peripherals : non local / small pages   
430    ### allocated in all clusters with name indexed by (x,y)
431    ### as vbase address is incremented by (cluster_xy * vseg_increment)
432    for x in xrange( x_size ):
433        for y in xrange( y_size ):
434            offset = ((x << y_width) + y) * peri_increment
435
436            mapping.addGlobal( 'seg_xcu_%d_%d' %(x,y), xcu_base + offset, xcu_size,
437                               '__W_', vtype = 'PERI' , x = x , y = y , pseg = 'XCU',
438                               local = False, big = False )
439
440            mapping.addGlobal( 'seg_mmc_%d_%d' %(x,y), mmc_base + offset, mmc_size,
441                               '__W_', vtype = 'PERI' , x = x , y = y , pseg = 'MMC',
442                               local = False, big = False )
443
444            if ( mwr_type != 'NONE' ):
445                mapping.addGlobal( 'seg_mwr_%d_%d' %(x,y), mwr_base + offset, mwr_size,
446                                   '__W_', vtype = 'PERI' , x = x , y = y , pseg = 'MWR',
447                                   local = False, big = False )
448
449    return mapping
450
451################################# platform test ####################################
452
453if __name__ == '__main__':
454
455    mapping = arch( x_size    = 2,
456                    y_size    = 2,
457                    nb_procs  = 2 )
458
459#   print mapping.netbsd_dts()
460
461    print mapping.xml()
462
463#   print mapping.giet_vsegs()
464
465
466# Local Variables:
467# tab-width: 4;
468# c-basic-offset: 4;
469# c-file-offsets:((innamespace . 0)(inline-open . 0));
470# indent-tabs-mode: nil;
471# End:
472#
473# vim: filetype=python:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
474
Note: See TracBrowser for help on using the repository browser.