Mercurial > ecos
annotate packages/hal/common/current/include/drv_api.h @ 177:4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
| author | jlarmour |
|---|---|
| date | Fri, 10 Aug 2001 19:27:55 +0000 |
| parents | eb9fd8c04db3 |
| children | e0c0827131d1 |
| rev | line source |
|---|---|
| 2 | 1 #ifndef CYGONCE_HAL_DRV_API_H |
| 2 #define CYGONCE_HAL_DRV_API_H | |
| 3 | |
| 4 /*========================================================================== | |
| 5 // | |
| 6 // drv_api.h | |
| 7 // | |
| 8 // Native API for Kernel | |
| 9 // | |
| 10 //========================================================================== | |
| 11 //####COPYRIGHTBEGIN#### | |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
12 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
13 // ------------------------------------------- |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
14 // The contents of this file are subject to the Red Hat eCos Public License |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
15 // Version 1.1 (the "License"); you may not use this file except in |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
16 // compliance with the License. You may obtain a copy of the License at |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
17 // http://www.redhat.com/ |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
18 // |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
19 // Software distributed under the License is distributed on an "AS IS" |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
20 // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
21 // License for the specific language governing rights and limitations under |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
22 // the License. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
23 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
24 // The Original Code is eCos - Embedded Configurable Operating System, |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
25 // released September 30, 1998. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
26 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
27 // The Initial Developer of the Original Code is Red Hat. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
28 // Portions created by Red Hat are |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
29 // Copyright (C) 1998, 1999, 2000 Red Hat, Inc. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
30 // All Rights Reserved. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
31 // ------------------------------------------- |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
32 // |
| 2 | 33 //####COPYRIGHTEND#### |
| 34 //========================================================================== | |
| 35 //#####DESCRIPTIONBEGIN#### | |
| 36 // | |
| 37 // Author(s): nickg | |
| 38 // Date: 1999-02-24 | |
| 39 // Purpose: Driver API | |
| 40 // Description: This file defines the API used by device drivers to access | |
| 41 // system services. When the kernel is present it maps directly | |
| 42 // to the Kernel C API. When the kernel is absent, it is provided | |
| 43 // by a set of HAL functions. | |
| 44 // | |
| 45 // Usage: #include <cyg/kernel/kapi.h> | |
| 46 // | |
| 47 //####DESCRIPTIONEND#### | |
| 48 // | |
| 49 //========================================================================*/ | |
| 50 | |
| 51 #include <pkgconf/hal.h> | |
| 52 #include <cyg/infra/cyg_type.h> | |
| 53 | |
| 54 #ifdef CYGPKG_KERNEL | |
| 55 | |
| 56 /*------------------------------------------------------------------------*/ | |
| 57 /* Kernel co-resident version of API */ | |
| 58 | |
| 59 #include <pkgconf/kernel.h> | |
| 60 | |
| 61 #ifndef CYGFUN_KERNEL_API_C | |
| 62 #error Driver API requres Kernel API to be present | |
| 63 #endif | |
| 64 | |
| 65 #include <cyg/kernel/kapi.h> | |
| 66 | |
| 67 #define cyg_drv_isr_lock cyg_interrupt_disable | |
| 68 #define cyg_drv_isr_unlock cyg_interrupt_enable | |
| 69 | |
| 70 #define cyg_drv_dsr_lock cyg_scheduler_lock | |
| 71 #define cyg_drv_dsr_unlock cyg_scheduler_unlock | |
| 72 | |
| 73 #define cyg_drv_mutex_t cyg_mutex_t | |
| 74 #define cyg_drv_mutex_init cyg_mutex_init | |
| 75 #define cyg_drv_mutex_destroy cyg_mutex_destroy | |
| 76 #define cyg_drv_mutex_lock cyg_mutex_lock | |
| 77 #define cyg_drv_mutex_trylock cyg_mutex_trylock | |
| 78 #define cyg_drv_mutex_unlock cyg_mutex_unlock | |
| 79 #define cyg_drv_mutex_release cyg_mutex_release | |
| 80 | |
| 81 #define cyg_drv_cond_t cyg_cond_t | |
| 82 #define cyg_drv_cond_init cyg_cond_init | |
| 83 #define cyg_drv_cond_destroy cyg_cond_destroy | |
| 84 #define cyg_drv_cond_wait cyg_cond_wait | |
| 85 #define cyg_drv_cond_signal cyg_cond_signal | |
| 86 #define cyg_drv_cond_broadcast cyg_cond_broadcast | |
| 87 | |
| 88 #define cyg_drv_interrupt_create cyg_interrupt_create | |
| 89 #define cyg_drv_interrupt_delete cyg_interrupt_delete | |
| 90 #define cyg_drv_interrupt_attach cyg_interrupt_attach | |
| 91 #define cyg_drv_interrupt_detach cyg_interrupt_detach | |
| 92 #define cyg_drv_interrupt_mask cyg_interrupt_mask | |
| 93 #define cyg_drv_interrupt_unmask cyg_interrupt_unmask | |
| 94 #define cyg_drv_interrupt_acknowledge cyg_interrupt_acknowledge | |
| 95 #define cyg_drv_interrupt_configure cyg_interrupt_configure | |
| 96 #define cyg_drv_interrupt_level cyg_interrupt_level | |
|
177
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
97 #define cyg_drv_interrupt_set_cpu cyg_interrupt_set_cpu |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
98 #define cyg_drv_interrupt_get_cpu cyg_interrupt_get_cpu |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
99 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
100 #define cyg_drv_spinlock_t cyg_spinlock_t |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
101 #define cyg_drv_spinlock_init cyg_spinlock_init |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
102 #define cyg_drv_spinlock_spin cyg_spinlock_spin |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
103 #define cyg_drv_spinlock_clear cyg_spinlock_clear |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
104 #define cyg_drv_spinlock_try cyg_spinlock_try |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
105 #define cyg_drv_spinlock_test cyg_spinlock_test |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
106 #define cyg_drv_spinlock_spin_intsave cyg_spinlock_spin_intsave |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
107 #define cyg_drv_spinlock_clear_intsave cyg_spinlock_clear_intsave |
| 2 | 108 |
| 109 #else /* CYGPKG_KERNEL */ | |
| 110 | |
| 111 /*------------------------------------------------------------------------*/ | |
| 112 /* Non-kernel version of API */ | |
| 113 | |
| 114 typedef CYG_ADDRWORD cyg_addrword_t; /* May hold pointer or word */ | |
| 115 typedef cyg_addrword_t cyg_handle_t; /* Object handle */ | |
| 116 typedef cyg_uint32 cyg_priority_t; /* type for priorities */ | |
| 117 typedef cyg_uint32 cyg_vector_t; /* Interrupt vector id */ | |
|
177
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
118 typedef cyg_uint32 cyg_cpu_t; /* CPU id */ |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
119 typedef int cyg_bool_t; |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
120 typedef cyg_int32 cyg_code_t; /* type for various codes */ |
| 2 | 121 |
| 122 typedef cyg_uint32 cyg_ISR_t( cyg_vector_t vector, cyg_addrword_t data); | |
| 123 typedef void cyg_DSR_t(cyg_vector_t vector, | |
| 124 cyg_ucount32 count, | |
| 125 cyg_addrword_t data); | |
| 126 | |
| 127 | |
| 128 externC void cyg_drv_isr_lock(void); | |
| 129 externC void cyg_drv_isr_unlock(void); | |
| 130 | |
| 131 externC void cyg_drv_dsr_lock(void); | |
| 132 externC void cyg_drv_dsr_unlock(void); | |
| 133 | |
| 134 typedef struct | |
| 135 { | |
| 136 cyg_atomic lock; | |
| 137 } cyg_drv_mutex_t; | |
| 138 | |
| 139 externC void cyg_drv_mutex_init( cyg_drv_mutex_t *mutex ); | |
| 140 externC void cyg_drv_mutex_destroy( cyg_drv_mutex_t *mutex ); | |
| 141 externC cyg_bool_t cyg_drv_mutex_lock( cyg_drv_mutex_t *mutex ); | |
| 142 externC cyg_bool_t cyg_drv_mutex_trylock( cyg_drv_mutex_t *mutex ); | |
| 143 externC void cyg_drv_mutex_unlock( cyg_drv_mutex_t *mutex ); | |
| 144 externC void cyg_drv_mutex_release( cyg_drv_mutex_t *mutex ); | |
| 145 | |
| 146 typedef struct | |
| 147 { | |
| 148 cyg_atomic wait; | |
| 149 cyg_drv_mutex_t *mutex; | |
| 150 } cyg_drv_cond_t; | |
| 151 | |
| 152 externC void cyg_drv_cond_init( cyg_drv_cond_t *cond, cyg_drv_mutex_t *mutex ); | |
| 153 externC void cyg_drv_cond_destroy( cyg_drv_cond_t *cond ); | |
|
115
6ed91473a1cd
Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents:
66
diff
changeset
|
154 externC cyg_bool_t cyg_drv_cond_wait( cyg_drv_cond_t *cond ); |
| 2 | 155 externC void cyg_drv_cond_signal( cyg_drv_cond_t *cond ); |
| 156 externC void cyg_drv_cond_broadcast( cyg_drv_cond_t *cond ); | |
| 157 | |
| 158 typedef struct cyg_interrupt | |
| 159 { | |
| 160 cyg_vector_t vector; | |
| 161 cyg_priority_t priority; | |
| 162 cyg_ISR_t *isr; | |
| 163 cyg_DSR_t *dsr; | |
| 164 CYG_ADDRWORD data; | |
| 165 | |
|
130
eb9fd8c04db3
Merge from eCos master repository on 2000-10-23-17:01:37-BST
jlarmour
parents:
115
diff
changeset
|
166 struct cyg_interrupt* volatile next_dsr; |
|
eb9fd8c04db3
Merge from eCos master repository on 2000-10-23-17:01:37-BST
jlarmour
parents:
115
diff
changeset
|
167 volatile cyg_int32 dsr_count; |
| 2 | 168 |
| 169 #ifdef CYGIMP_HAL_COMMON_INTERRUPTS_CHAIN | |
| 170 struct cyg_interrupt *next; | |
| 171 #endif | |
| 172 | |
| 173 } cyg_interrupt; | |
| 174 | |
| 175 externC void cyg_drv_interrupt_create( | |
| 176 cyg_vector_t vector, | |
| 177 cyg_priority_t priority, | |
| 178 cyg_addrword_t data, | |
| 179 cyg_ISR_t *isr, | |
| 180 cyg_DSR_t *dsr, | |
| 181 cyg_handle_t *handle, | |
| 182 cyg_interrupt *intr | |
| 183 ); | |
| 184 externC void cyg_drv_interrupt_delete( cyg_handle_t interrupt ); | |
| 185 externC void cyg_drv_interrupt_attach( cyg_handle_t interrupt ); | |
| 186 externC void cyg_drv_interrupt_detach( cyg_handle_t interrupt ); | |
| 187 | |
| 188 externC void cyg_drv_interrupt_mask( cyg_vector_t vector ); | |
| 189 externC void cyg_drv_interrupt_unmask( cyg_vector_t vector ); | |
| 190 externC void cyg_drv_interrupt_acknowledge( cyg_vector_t vector ); | |
| 191 externC void cyg_drv_interrupt_configure( | |
| 192 cyg_vector_t vector, | |
| 193 cyg_bool_t level, | |
| 194 cyg_bool_t up | |
| 195 ); | |
| 196 externC void cyg_drv_interrupt_level( cyg_vector_t vector, cyg_priority_t level ); | |
|
177
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
197 externC void cyg_drv_interrupt_set_cpu( cyg_vector_t vector, cyg_cpu_t cpu ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
198 externC cyg_cpu_t cyg_drv_interrupt_get_cpu( cyg_vector_t vector ); |
| 2 | 199 |
| 200 | |
| 201 enum cyg_ISR_results | |
| 202 { | |
| 203 CYG_ISR_HANDLED = 1, /* Interrupt was handled */ | |
| 204 CYG_ISR_CALL_DSR = 2 /* Schedule DSR */ | |
| 205 }; | |
| 206 | |
|
177
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
207 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
208 typedef struct |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
209 { |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
210 cyg_atomic lock; |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
211 } cyg_drv_spinlock_t; |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
212 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
213 void cyg_drv_spinlock_init( |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
214 cyg_drv_spinlock_t *lock, /* spinlock to initialize */ |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
215 cyg_bool_t locked /* init locked or unlocked */ |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
216 ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
217 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
218 void cyg_drv_spinlock_destroy( cyg_drv_spinlock_t *lock ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
219 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
220 void cyg_drv_spinlock_spin( cyg_drv_spinlock_t *lock ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
221 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
222 void cyg_drv_spinlock_clear( cyg_drv_spinlock_t *lock ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
223 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
224 cyg_bool_t cyg_drv_spinlock_try( cyg_drv_spinlock_t *lock ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
225 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
226 cyg_bool_t cyg_drv_spinlock_test( cyg_drv_spinlock_t *lock ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
227 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
228 void cyg_drv_spinlock_spin_intsave( cyg_drv_spinlock_t *lock, |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
229 cyg_addrword_t *istate ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
230 |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
231 void cyg_drv_spinlock_clear_intsave( cyg_drv_spinlock_t *lock, |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
232 cyg_addrword_t istate ); |
|
4c750ce71ae3
Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents:
130
diff
changeset
|
233 |
| 2 | 234 #endif /* CYGPKG_KERNEL */ |
| 235 | |
| 236 /*------------------------------------------------------------------------*/ | |
| 237 /* EOF drv_api.h */ | |
| 238 #endif // CYGONCE_HAL_DRV_API_H |
