source: rtems/c/src/lib/libbsp/powerpc/mvme3100/README @ b599faa

4.104.114.95
Last change on this file since b599faa was b599faa, checked in by Till Straumann <strauman@…>, on Dec 14, 2007 at 6:30:15 AM
  • imported MVME3100 BSP (from SLAC repository)
  • Property mode set to 100644
File size: 4.7 KB
Line 
1Some information about this BSP
2================================
3
4ACKNOWLEDGEMENTS
5----------------
6Acknowledgements:
7
8 Valuable information was obtained from the following drivers
9
10    linux: (BCM54xx) Maciej W. Rozycki, Amy Fong.
11
12 This BSP also builds on top of the work of others who have contributed
13 to similar RTEMS (powerpc) BSPs, most notably Eric Valette, Eric Norum
14 and others.
15
16 This BSP was produced by the Stanford Linear Accelerator Center,
17 Stanford University under contract with the US Department of Energy.
18
19LICENSE
20-------
21See ./LICENSE file.
22
23Note that not all files that are part of this BSP were written by
24myself. Consult individual file headers for copyright
25and authorship information.
26
27HARDWARE SUPPORT
28===============
29(some of the headers mentioned below contain more
30detailed information)
31
32NOTE:  The BSP supports the mvme3100 board.
33
34CONSOLE: 2 serial devices, UART driver from 'shared' - no surprises
35       ("/dev/ttyS0", [="/dev/console"], "/dev/ttyS1"). (Only
36       /dev/ttyS0 is accessible from the front panel.)
37
38CLOCK: Decrementer, same as other PPC BSPs. (FIXME: a openpic timer
39       could be used.) The bookE decrementer is slightly different
40           from the classic PPC decrementer but the differences are
41           hidden from the user.
42
43PIC (interrupt controller) (bsp/irq.h): OpenPIC integrated with
44       the MPC8540. (see also: bsp/openpic.h).
45
46PCI (bsp/pci.h):
47       In addition to rtems' PCI API, a call is available to scan
48       all devices executing a user callback on each device.
49       BSP_pciConfigDump() is a convenience wrapper dumping essential
50       information (IDs, BAs, IRQ pin/line) to the console or a file.
51
52MEMORY MAP: MotLoad; all addresses (MEM + I/O) read from PCI config. space
53       are CPU addresses. For sake of portability, drivers should still
54       use the _IO_BASE, PCI_MEM_BASE, PCI_DRAM_OFFSET constants.
55
56NVRAM: No NVRAM.
57
58FLASH (bsp/flashPgm.h): Routines to write flash. Highest level
59      wrapper writes a file to flash.
60          NOTE: Writing to flash is disabled by default;
61                call BSP_flashWriteEnable().
62
63I2C (bsp.h, rtems/libi2c.h, libchip/i2c-xxx.h):  temp. sensor, eeprom
64      and real-time clock (RTC) are available as device files (bsp.h);
65          lower-level interface is provided by libi2c.h.
66
67          Available i2c devices are:
68
69                                /dev/i2c0.vpd-eeprom
70                                /dev/i2c0.usr-eeprom
71                                /dev/i2c0.usr1-eeprom
72                                /dev/i2c0.ds1621
73                                /dev/i2c0.ds1621-raw
74                                /dev/i2c0.ds1375-raw
75
76      You can e.g., read the board temperature:
77                            fd = open("/dev/i2c0.ds1621",O_RDONLY)
78                                read(fd,&temp,1)
79                                close(fd);
80                                printf("Board Temp. is %idegC\n",(int)temp);
81
82VME: (bsp/VME.h, bsp/vme_am_defs.h, bsp/VMEDMA.h).
83      *always* use VME.h API, if possible; do *not* use chip driver
84          (vmeTsi148.h) directly unless you know what you are
85          doing (i.e., if you need specific features provided by the particular
86          chip)
87
88      VMEConfig.h should not be used by applications as it makes them
89      dependent on BSP internals. VMEConfig.h is intended to be used
90          by BSP designers only.
91
92      VME interrupt priorities: the VME bridge(s) do not implement
93      priorities in hardware.
94      However, on the 3100 multiple physical interrupt
95      lines/wires connect the VME bridge to the PIC. Hence, it is possible
96      to assign the different wires different priorities at the PIC
97      (see bsp/openpic.h) and to route VME interrupts to different
98          wires according to their priority.
99          You need to call driver specific routines
100      for this (vmeXXXIntRoute()), however (for driver-specific API
101          consult bsp/vmeTsi148.h).
102
103          For VME DMA *always* use the bsp/VMEDMA.h API. DO NOT use
104          chip-specific features. Applications written using the bsp/VMEDMA.h
105          API are portable between the UniverseII and the Tsi148.
106
107HARDWARE TIMERS: (bsp/openpic.h). Programmable general-purpose
108      timers. Routines are provided to setup, start and stop
109          GPTs. The setup routine allows for specifying single-shot or periodic
110          mode and dispatches a user ISR when the GPT expires.
111
112NETWORK: (bsp/if_tsec_pub.h). In addition to the standard bsdnet
113      'attach' function the driver offers a low-level API that
114          can be used to implement alternate communication links
115          which are totally decoupled from BSDNET.
116
117          Consult 'KNOWN_PROBLEMS'.
118
119VPD: (bsp/vpd.h). The board's VPD (vital-product-data such as S/N,
120      MAC addresses and so forth) can be retrieved.
121
122BOOTING: BSP has a relocator-header. Clear MSR and jump to the first
123      instruction in the binary. R3 and R4, if non-null, point to the
124      start/end of an optional command line string that is copied into
125      BSP_commandline_string. The BSP is compatible with 'netboot'.
126
127Have fun.
128
129-- Till Straumann <strauman@slac.stanford.edu>, 2007.
Note: See TracBrowser for help on using the repository browser.