source: rtems/c/src/lib/libbsp/sparc/leon3/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.6 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup sparc_leon3
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_leon3 LEON3 Support
46 *
47 *  @ingroup bsp_sparc
48 *
49 *  @brief LEON3 support package
50 *
51 */
52
53/* SPARC CPU variant: LEON3 */
54#define LEON3 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/* Maximum supported APBUARTs by BSP */
63#define BSP_NUMBER_OF_TERMIOS_PORTS 8
64
65/*
66 * Network driver configuration
67 */
68struct rtems_bsdnet_ifconfig;
69extern int rtems_leon_open_eth_driver_attach(
70  struct rtems_bsdnet_ifconfig *config,
71  int attach
72);
73extern int rtems_smc91111_driver_attach_leon3(
74  struct rtems_bsdnet_ifconfig *config,
75  int attach
76);
77extern int rtems_leon_greth_driver_attach(
78  struct rtems_bsdnet_ifconfig *config,
79  int attach
80);
81
82#define RTEMS_BSP_NETWORK_DRIVER_NAME_OPENETH   "open_eth1"
83#define RTEMS_BSP_NETWORK_DRIVER_ATTACH_OPENETH  rtems_leon_open_eth_driver_attach
84#define RTEMS_BSP_NETWORK_DRIVER_NAME_SMC91111  "smc_eth1"
85#define RTEMS_BSP_NETWORK_DRIVER_ATTACH_SMC91111 rtems_smc91111_driver_attach_leon3
86#define RTEMS_BSP_NETWORK_DRIVER_NAME_GRETH      "gr_eth1"
87#define RTEMS_BSP_NETWORK_DRIVER_ATTACH_GRETH    rtems_leon_greth_driver_attach
88
89#ifndef RTEMS_BSP_NETWORK_DRIVER_NAME
90#define RTEMS_BSP_NETWORK_DRIVER_NAME   RTEMS_BSP_NETWORK_DRIVER_NAME_GRETH
91#define RTEMS_BSP_NETWORK_DRIVER_ATTACH RTEMS_BSP_NETWORK_DRIVER_ATTACH_GRETH
92#endif
93
94#define HAS_SMC91111
95
96/* Configure GRETH driver */
97#define GRETH_SUPPORTED
98#define GRETH_MEM_LOAD(addr) leon_r32_no_cache(addr)
99
100extern int   CPU_SPARC_HAS_SNOOPING;
101
102/* Constants */
103
104/*
105 *  Information placed in the linkcmds file.
106 */
107
108extern int   RAM_START;
109extern int   RAM_END;
110extern int   RAM_SIZE;
111
112extern int   PROM_START;
113extern int   PROM_END;
114extern int   PROM_SIZE;
115
116extern int   CLOCK_SPEED;
117
118extern int   end;        /* last address in the program */
119
120/* miscellaneous stuff assumed to exist */
121
122rtems_isr_entry set_vector(                     /* returns old vector */
123    rtems_isr_entry     handler,                /* isr routine        */
124    rtems_vector_number vector,                 /* vector number      */
125    int                 type                    /* RTEMS or RAW intr  */
126);
127
128void BSP_fatal_return( void );
129
130void bsp_spurious_initialize( void );
131
132/* Allocate 8-byte aligned non-freeable pre-malloc() memory. The function
133 * can be called at any time. The work-area will shrink when called before
134 * bsp_work_area_initialize(). malloc() is called to get memory when this function
135 * is called after bsp_work_area_initialize().
136 */
137void *bsp_early_malloc(int size);
138
139/* Interrupt Service Routine (ISR) pointer */
140typedef void (*bsp_shared_isr)(void *arg);
141
142/* Initializes the Shared System Interrupt service */
143extern void BSP_shared_interrupt_init(void);
144
145/* Registers a shared IRQ handler, and enable it at IRQ controller. Multiple
146 * interrupt handlers may use the same IRQ number, all ISRs will be called
147 * when an interrupt on that line is fired.
148 *
149 * Arguments
150 *  irq       System IRQ number
151 *  info      Optional Name of IRQ source
152 *  isr       Function pointer to the ISR
153 *  arg       Second argument to function isr
154 */
155static __inline__ int BSP_shared_interrupt_register
156       (
157       int irq,
158       const char *info,
159       bsp_shared_isr isr,
160       void *arg
161       )
162{
163       return rtems_interrupt_handler_install(irq, info,
164                                       RTEMS_INTERRUPT_SHARED, isr, arg);
165}
166
167/* Unregister previously registered shared IRQ handler.
168 *
169 * Arguments
170 *  irq       System IRQ number
171 *  isr       Function pointer to the ISR
172 *  arg       Second argument to function isr
173 */
174static __inline__ int BSP_shared_interrupt_unregister
175       (
176       int irq,
177       bsp_shared_isr isr,
178       void *arg
179       )
180{
181       return rtems_interrupt_handler_remove(irq, isr, arg);
182}
183
184/* Clear interrupt pending on IRQ controller, this is typically done on a
185 * level triggered interrupt source such as PCI to avoid taking double IRQs.
186 * In such a case the interrupt source must be cleared first on LEON, before
187 * acknowledging the IRQ with this function.
188 *
189 * Arguments
190 *  irq       System IRQ number
191 */
192extern void BSP_shared_interrupt_clear(int irq);
193
194/* Enable Interrupt. This function will unmask the IRQ at the interrupt
195 * controller. This is normally done by _register(). Note that this will
196 * affect all ISRs on this IRQ.
197 *
198 * Arguments
199 *  irq       System IRQ number
200 */
201extern void BSP_shared_interrupt_unmask(int irq);
202
203/* Disable Interrupt. This function will mask one IRQ at the interrupt
204 * controller. This is normally done by _unregister().  Note that this will
205 * affect all ISRs on this IRQ.
206 *
207 * Arguments
208 *  irq         System IRQ number
209 */
210extern void BSP_shared_interrupt_mask(int irq);
211
212#ifdef __cplusplus
213}
214#endif
215
216#endif
217
218
Note: See TracBrowser for help on using the repository browser.