Mercurial > flash_v2
annotate packages/hal/common/current/include/drv_api.h @ 64:c38311975d4f ecos-sw-2000-01-28
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
| author | jlarmour |
|---|---|
| date | Fri, 28 Jan 2000 04:59:39 +0000 |
| parents | 443894e2e912 |
| children | bf00f99aec69 |
| 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 |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
15 // Version 1.0 (the "License"); you may not use this file except in |
|
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 |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
17 // http://sourceware.cygnus.com/ecos |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
18 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
2
diff
changeset
|
19 // Software distributed under the License is distributed on an |
|
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 | |
| 97 | |
| 98 #else /* CYGPKG_KERNEL */ | |
| 99 | |
| 100 /*------------------------------------------------------------------------*/ | |
| 101 /* Non-kernel version of API */ | |
| 102 | |
| 103 typedef CYG_ADDRWORD cyg_addrword_t; /* May hold pointer or word */ | |
| 104 typedef cyg_addrword_t cyg_handle_t; /* Object handle */ | |
| 105 typedef cyg_uint32 cyg_priority_t; /* type for priorities */ | |
| 106 typedef cyg_uint32 cyg_vector_t; /* Interrupt vector id */ | |
| 107 typedef int cyg_bool_t; | |
| 108 | |
| 109 typedef cyg_uint32 cyg_ISR_t( cyg_vector_t vector, cyg_addrword_t data); | |
| 110 typedef void cyg_DSR_t(cyg_vector_t vector, | |
| 111 cyg_ucount32 count, | |
| 112 cyg_addrword_t data); | |
| 113 | |
| 114 | |
| 115 externC void cyg_drv_isr_lock(void); | |
| 116 externC void cyg_drv_isr_unlock(void); | |
| 117 | |
| 118 externC void cyg_drv_dsr_lock(void); | |
| 119 externC void cyg_drv_dsr_unlock(void); | |
| 120 | |
| 121 typedef struct | |
| 122 { | |
| 123 cyg_atomic lock; | |
| 124 } cyg_drv_mutex_t; | |
| 125 | |
| 126 externC void cyg_drv_mutex_init( cyg_drv_mutex_t *mutex ); | |
| 127 externC void cyg_drv_mutex_destroy( cyg_drv_mutex_t *mutex ); | |
| 128 externC cyg_bool_t cyg_drv_mutex_lock( cyg_drv_mutex_t *mutex ); | |
| 129 externC cyg_bool_t cyg_drv_mutex_trylock( cyg_drv_mutex_t *mutex ); | |
| 130 externC void cyg_drv_mutex_unlock( cyg_drv_mutex_t *mutex ); | |
| 131 externC void cyg_drv_mutex_release( cyg_drv_mutex_t *mutex ); | |
| 132 | |
| 133 typedef struct | |
| 134 { | |
| 135 cyg_atomic wait; | |
| 136 cyg_drv_mutex_t *mutex; | |
| 137 } cyg_drv_cond_t; | |
| 138 | |
| 139 externC void cyg_drv_cond_init( cyg_drv_cond_t *cond, cyg_drv_mutex_t *mutex ); | |
| 140 externC void cyg_drv_cond_destroy( cyg_drv_cond_t *cond ); | |
| 141 externC void cyg_drv_cond_wait( cyg_drv_cond_t *cond ); | |
| 142 externC void cyg_drv_cond_signal( cyg_drv_cond_t *cond ); | |
| 143 externC void cyg_drv_cond_broadcast( cyg_drv_cond_t *cond ); | |
| 144 | |
| 145 typedef struct cyg_interrupt | |
| 146 { | |
| 147 cyg_vector_t vector; | |
| 148 cyg_priority_t priority; | |
| 149 cyg_ISR_t *isr; | |
| 150 cyg_DSR_t *dsr; | |
| 151 CYG_ADDRWORD data; | |
| 152 | |
| 153 volatile struct cyg_interrupt *next_dsr; | |
| 154 cyg_int32 dsr_count; | |
| 155 | |
| 156 #ifdef CYGIMP_HAL_COMMON_INTERRUPTS_CHAIN | |
| 157 struct cyg_interrupt *next; | |
| 158 #endif | |
| 159 | |
| 160 } cyg_interrupt; | |
| 161 | |
| 162 externC void cyg_drv_interrupt_create( | |
| 163 cyg_vector_t vector, | |
| 164 cyg_priority_t priority, | |
| 165 cyg_addrword_t data, | |
| 166 cyg_ISR_t *isr, | |
| 167 cyg_DSR_t *dsr, | |
| 168 cyg_handle_t *handle, | |
| 169 cyg_interrupt *intr | |
| 170 ); | |
| 171 externC void cyg_drv_interrupt_delete( cyg_handle_t interrupt ); | |
| 172 externC void cyg_drv_interrupt_attach( cyg_handle_t interrupt ); | |
| 173 externC void cyg_drv_interrupt_detach( cyg_handle_t interrupt ); | |
| 174 | |
| 175 externC void cyg_drv_interrupt_mask( cyg_vector_t vector ); | |
| 176 externC void cyg_drv_interrupt_unmask( cyg_vector_t vector ); | |
| 177 externC void cyg_drv_interrupt_acknowledge( cyg_vector_t vector ); | |
| 178 externC void cyg_drv_interrupt_configure( | |
| 179 cyg_vector_t vector, | |
| 180 cyg_bool_t level, | |
| 181 cyg_bool_t up | |
| 182 ); | |
| 183 externC void cyg_drv_interrupt_level( cyg_vector_t vector, cyg_priority_t level ); | |
| 184 | |
| 185 | |
| 186 enum cyg_ISR_results | |
| 187 { | |
| 188 CYG_ISR_HANDLED = 1, /* Interrupt was handled */ | |
| 189 CYG_ISR_CALL_DSR = 2 /* Schedule DSR */ | |
| 190 }; | |
| 191 | |
| 192 #endif /* CYGPKG_KERNEL */ | |
| 193 | |
| 194 /*------------------------------------------------------------------------*/ | |
| 195 /* EOF drv_api.h */ | |
| 196 #endif // CYGONCE_HAL_DRV_API_H |