source: rtems/c/src/lib/libbsp/sparc/leon2/include/bsp.h @ 296c74e6

4.11
Last change on this file since 296c74e6 was 296c74e6, checked in by Daniel Ramirez <javamonn@…>, on Dec 9, 2013 at 7:37:48 PM

doxygen: refactored doxygen in libbsp to illustrate new rule set

  • Property mode set to 100644
File size: 5.1 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup sparc_leon2
5 *
6 * @brief Global BSP Definitions.
7 */
8
9/*  bsp.h
10 *
11 *  This include file contains all SPARC simulator definitions.
12 *
13 *  COPYRIGHT (c) 1989-1998.
14 *  On-Line Applications Research Corporation (OAR).
15 *
16 *  The license and distribution terms for this file may be
17 *  found in the file LICENSE in this distribution or at
18 *  http://www.rtems.com/license/LICENSE.
19 *
20 *  Ported to ERC32 implementation of the SPARC by On-Line Applications
21 *  Research Corporation (OAR) under contract to the European Space
22 *  Agency (ESA).
23 *
24 *  ERC32 modifications of respective RTEMS file: COPYRIGHT (c) 1995.
25 *  European Space Agency.
26 */
27
28#ifndef _BSP_H
29#define _BSP_H
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35#include <bspopts.h>
36#include <bsp/default-initial-extension.h>
37
38#include <rtems.h>
39#include <leon.h>
40#include <rtems/clockdrv.h>
41#include <rtems/console.h>
42#include <rtems/irq-extension.h>
43
44/**
45 *  @defgroup sparc_leon2 LEON2 Support
46 *
47 *  @ingroup bsp_sparc
48 *
49 *  @brief LEON2 Support Package
50 *
51 */
52
53/* SPARC CPU variant: LEON2 */
54#define LEON2 1
55
56/*
57 *  BSP provides its own Idle thread body
58 */
59void *bsp_idle_thread( uintptr_t ignored );
60#define BSP_IDLE_TASK_BODY bsp_idle_thread
61
62/*
63 * Network driver configuration
64 */
65struct rtems_bsdnet_ifconfig;
66extern int rtems_leon_open_eth_driver_attach(
67  struct rtems_bsdnet_ifconfig *config
68);
69extern int rtems_smc91111_driver_attach_leon2(
70  struct rtems_bsdnet_ifconfig *config
71);
72#define RTEMS_BSP_NETWORK_DRIVER_NAME   "open_eth1"
73#define RTEMS_BSP_NETWORK_DRIVER_ATTACH_OPENETH \
74          rtems_leon_open_eth_driver_attach
75#define RTEMS_BSP_NETWORK_DRIVER_ATTACH_SMC91111 \
76          rtems_smc91111_driver_attach_leon2
77
78#define HAS_SMC91111
79
80/* Configure GRETH driver */
81#define GRETH_SUPPORTED
82#define GRETH_MEM_LOAD(addr) leon_r32_no_cache(addr)
83
84/*
85 *  The synchronous trap is an arbitrarily chosen software trap.
86 */
87
88extern int   CPU_SPARC_HAS_SNOOPING;
89
90/* Constants */
91
92/*
93 *  Information placed in the linkcmds file.
94 */
95
96extern int   RAM_START;
97extern int   RAM_END;
98extern int   RAM_SIZE;
99
100extern int   PROM_START;
101extern int   PROM_END;
102extern int   PROM_SIZE;
103
104extern int   CLOCK_SPEED;
105
106extern int   end;        /* last address in the program */
107
108/* miscellaneous stuff assumed to exist */
109
110rtems_isr_entry set_vector(                     /* returns old vector */
111    rtems_isr_entry     handler,                /* isr routine        */
112    rtems_vector_number vector,                 /* vector number      */
113    int                 type                    /* RTEMS or RAW intr  */
114);
115
116void BSP_fatal_return( void );
117
118void bsp_spurious_initialize( void );
119
120/* Allocate 8-byte aligned non-freeable pre-malloc() memory. The function
121 * can be called at any time. The work-area will shrink when called before
122 * bsp_work_area_initialize(). malloc() is called to get memory when this function
123 * is called after bsp_work_area_initialize().
124 */
125void *bsp_early_malloc(int size);
126
127/* Interrupt Service Routine (ISR) pointer */
128typedef void (*bsp_shared_isr)(void *arg);
129
130/* Initializes the Shared System Interrupt service */
131extern void BSP_shared_interrupt_init(void);
132
133/* Registers a shared IRQ handler, and enable it at IRQ controller. Multiple
134 * interrupt handlers may use the same IRQ number, all ISRs will be called
135 * when an interrupt on that line is fired.
136 *
137 * Arguments
138 *  irq       System IRQ number
139 *  info      Optional Name of IRQ source
140 *  isr       Function pointer to the ISR
141 *  arg       Second argument to function isr
142 */
143static __inline__ int BSP_shared_interrupt_register
144       (
145       int irq,
146       const char *info,
147       bsp_shared_isr isr,
148       void *arg
149       )
150{
151       return rtems_interrupt_handler_install(irq, info,
152                                       RTEMS_INTERRUPT_SHARED, isr, arg);
153}
154
155/* Unregister previously registered shared IRQ handler.
156 *
157 * Arguments
158 *  irq       System IRQ number
159 *  isr       Function pointer to the ISR
160 *  arg       Second argument to function isr
161 */
162static __inline__ int BSP_shared_interrupt_unregister
163       (
164       int irq,
165       bsp_shared_isr isr,
166       void *arg
167       )
168{
169       return rtems_interrupt_handler_remove(irq, isr, arg);
170}
171
172/* Clear interrupt pending on IRQ controller, this is typically done on a
173 * level triggered interrupt source such as PCI to avoid taking double IRQs.
174 * In such a case the interrupt source must be cleared first on LEON, before
175 * acknowledging the IRQ with this function.
176 *
177 * Arguments
178 *  irq       System IRQ number
179 */
180extern void BSP_shared_interrupt_clear(int irq);
181
182/* Enable Interrupt. This function will unmask the IRQ at the interrupt
183 * controller. This is normally done by _register(). Note that this will
184 * affect all ISRs on this IRQ.
185 *
186 * Arguments
187 *  irq       System IRQ number
188 */
189extern void BSP_shared_interrupt_unmask(int irq);
190
191/* Disable Interrupt. This function will mask one IRQ at the interrupt
192 * controller. This is normally done by _unregister().  Note that this will
193 * affect all ISRs on this IRQ.
194 *
195 * Arguments
196 *  irq         System IRQ number
197 */
198extern void BSP_shared_interrupt_mask(int irq);
199
200#ifdef __cplusplus
201}
202#endif
203
204#endif
Note: See TracBrowser for help on using the repository browser.