annotate packages/kernel/current/include/kapi.h @ 263:c0d53837cb68

Allow configurations which have the kernel but not the memalloc package.
author bartv
date Mon, 05 Aug 2002 21:52:58 +0000
parents 9091c290be62
children a65a4055f146
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
1 #ifndef CYGONCE_KERNEL_KAPI_H
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
2 #define CYGONCE_KERNEL_KAPI_H
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
3
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
4 /*==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
5 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
6 // kapi.h
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
7 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
8 // Native API for Kernel
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
9 //
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
10 //==========================================================================
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
11 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
12 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
13 // This file is part of eCos, the Embedded Configurable Operating System.
263
c0d53837cb68 Allow configurations which have the kernel but not the memalloc
bartv
parents: 215
diff changeset
14 // Copyright (C) 2002 Bart Veer
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
15 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
16 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
17 // eCos is free software; you can redistribute it and/or modify it under
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
18 // the terms of the GNU General Public License as published by the Free
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
19 // Software Foundation; either version 2 or (at your option) any later version.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
20 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
21 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
22 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
23 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
24 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
25 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
26 // You should have received a copy of the GNU General Public License along
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
27 // with eCos; if not, write to the Free Software Foundation, Inc.,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
28 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
29 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
30 // As a special exception, if other files instantiate templates or use macros
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
31 // or inline functions from this file, or you compile this file and link it
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
32 // with other works to produce a work based on this file, this file does not
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
33 // by itself cause the resulting work to be covered by the GNU General Public
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
34 // License. However the source code for this file must still be made available
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
35 // in accordance with section (3) of the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
36 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
37 // This exception does not invalidate any other reasons why a work based on
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
38 // this file might be covered by the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
39 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
40 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
210
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
41 // at http://sources.redhat.com/ecos/ecos-license/
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
42 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
43 //####ECOSGPLCOPYRIGHTEND####
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
44 //==========================================================================
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
45 //#####DESCRIPTIONBEGIN####
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
46 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
47 // Author(s): nickg, dsm
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
48 // Contributors: nickg
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
49 // Date: 1998-03-02
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
50 // Purpose: Native API for Kernel
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
51 // Description: This file describes the native API for using the kernel.
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
52 // It is essentially a set of C wrappers for the C++ class
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
53 // member functions.
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
54 // Usage: #include <cyg/kernel/kapi.h>
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
55 //
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
56 //####DESCRIPTIONEND####
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
57 //
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
58 //========================================================================*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
59
263
c0d53837cb68 Allow configurations which have the kernel but not the memalloc
bartv
parents: 215
diff changeset
60 #include <pkgconf/system.h>
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
61 #include <pkgconf/kernel.h>
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
62
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
63 #ifdef CYGFUN_KERNEL_API_C
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
64 #include <cyg/infra/cyg_type.h>
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
65
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
66 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
67
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
68 #ifdef __cplusplus
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
69 extern "C" {
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
70 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
71
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
72 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
73 /* The following are derived types, they may have different */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
74 /* definitions from these depending on configuration. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
75
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
76 typedef CYG_ADDRWORD cyg_addrword_t; /* May hold pointer or word */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
77 typedef cyg_addrword_t cyg_handle_t; /* Object handle */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
78 typedef cyg_uint32 cyg_priority_t; /* type for priorities */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
79 typedef cyg_int32 cyg_code_t; /* type for various codes */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
80 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: 147
diff changeset
81 typedef cyg_uint32 cyg_cpu_t; /* CPU id type */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
82
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
83 typedef cyg_uint64 cyg_tick_count_t;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
84
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
85 typedef int cyg_bool_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
86
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
87 /* Exception handler function definition */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
88 typedef void cyg_exception_handler_t(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
89 cyg_addrword_t data,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
90 cyg_code_t exception_number,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
91 cyg_addrword_t info
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
92 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
93
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
94 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
95 struct cyg_thread;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
96 typedef struct cyg_thread cyg_thread;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
97
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
98 struct cyg_interrupt;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
99 typedef struct cyg_interrupt cyg_interrupt;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
100
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
101 struct cyg_counter;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
102 typedef struct cyg_counter cyg_counter;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
103
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
104 struct cyg_clock;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
105 typedef struct cyg_clock cyg_clock;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
106
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
107 struct cyg_alarm;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
108 typedef struct cyg_alarm cyg_alarm;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
109
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
110 struct cyg_mbox;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
111 typedef struct cyg_mbox cyg_mbox;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
112
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
113 struct cyg_sem_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
114 typedef struct cyg_sem_t cyg_sem_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
115
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
116 struct cyg_flag_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
117 typedef struct cyg_flag_t cyg_flag_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
118
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
119 struct cyg_mutex_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
120 typedef struct cyg_mutex_t cyg_mutex_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
121
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
122 struct cyg_cond_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
123 typedef struct cyg_cond_t cyg_cond_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
124
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
125 struct cyg_spinlock_t;
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
126 typedef struct cyg_spinlock_t cyg_spinlock_t;
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
127
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
128 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
129 /* Scheduler operations */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
130
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
131 /* Starts scheduler with created threads. Never returns. */
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
132 void cyg_scheduler_start(void) CYGBLD_ATTRIB_NORET;
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
133
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
134 /* Lock and unlock the scheduler. When the scheduler is */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
135 /* locked thread preemption is disabled. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
136 void cyg_scheduler_lock(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
137
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
138 void cyg_scheduler_unlock(void);
84
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 66
diff changeset
139
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 66
diff changeset
140 /* Just like 'cyg_scheduler_lock()', but never take the lock higher than 1 */
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 66
diff changeset
141 /* Thus this call is safe even if the scheduler is already locked and a */
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 66
diff changeset
142 /* subsequent call to 'cyg_scheduler_unlock()' will completely unlock. */
489eb5632bc3 Merge from eCos master repository on 2000-04-28-18:44:39-BST
jlarmour
parents: 66
diff changeset
143 void cyg_scheduler_safe_lock(void);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
144
105
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 84
diff changeset
145 /* Read the scheduler lock value. */
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 84
diff changeset
146 cyg_ucount32 cyg_scheduler_read_lock(void);
5a0cc6c243a9 Merge from eCos master repository on 2000-06-30-08:18:49-BST
jlarmour
parents: 84
diff changeset
147
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
148 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
149 /* Thread operations */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
150
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
151 typedef void cyg_thread_entry_t(cyg_addrword_t);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
152
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
153 void cyg_thread_create(
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
154 cyg_addrword_t sched_info, /* scheduling info (eg pri) */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
155 cyg_thread_entry_t *entry, /* entry point function */
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
156 cyg_addrword_t entry_data, /* entry data */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
157 char *name, /* optional thread name */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
158 void *stack_base, /* stack base, NULL = alloc */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
159 cyg_ucount32 stack_size, /* stack size, 0 = default */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
160 cyg_handle_t *handle, /* returned thread handle */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
161 cyg_thread *thread /* put thread here */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
162 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
163
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
164 void cyg_thread_exit(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
165
8
ece80412419a Merge from eCos master repository on 1999-05-21-22:05:54-BST
jlarmour
parents: 2
diff changeset
166 /* It may be necessary to arrange for the victim to run for it to disappear */
ece80412419a Merge from eCos master repository on 1999-05-21-22:05:54-BST
jlarmour
parents: 2
diff changeset
167 cyg_bool_t cyg_thread_delete(cyg_handle_t thread); /* false if NOT deleted */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
168
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
169 void cyg_thread_suspend(cyg_handle_t thread);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
170
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
171 void cyg_thread_resume(cyg_handle_t thread);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
172
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
173 void cyg_thread_kill(cyg_handle_t thread);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
174
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
175 void cyg_thread_release(cyg_handle_t thread);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
176
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
177 void cyg_thread_yield(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
178
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
179 cyg_handle_t cyg_thread_self(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
180
10
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
181 cyg_handle_t cyg_thread_idle_thread(void);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
182
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
183 /* Priority manipulation */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
184
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
185 void cyg_thread_set_priority(cyg_handle_t thread, cyg_priority_t priority );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
186
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
187 cyg_priority_t cyg_thread_get_priority(cyg_handle_t thread);
179
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
188 cyg_priority_t cyg_thread_get_current_priority(cyg_handle_t thread);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
189
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
190 /* Deadline scheduling control (optional) */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
191
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
192 void cyg_thread_deadline_wait(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
193 cyg_tick_count_t start_time, /* abs earliest start time */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
194 cyg_tick_count_t run_time, /* worst case execution time */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
195 cyg_tick_count_t deadline /* absolute deadline */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
196 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
197
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
198 void cyg_thread_delay(cyg_tick_count_t delay);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
199
10
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
200 /* Stack information */
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
201 cyg_addrword_t cyg_thread_get_stack_base(cyg_handle_t thread);
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
202
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
203 cyg_uint32 cyg_thread_get_stack_size(cyg_handle_t thread);
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
204
147
d397fc472bcf Merge from eCos master repository on 2001-01-05-06:43:02-GMT
jlarmour
parents: 115
diff changeset
205 #ifdef CYGFUN_KERNEL_THREADS_STACK_MEASUREMENT
d397fc472bcf Merge from eCos master repository on 2001-01-05-06:43:02-GMT
jlarmour
parents: 115
diff changeset
206 cyg_uint32 cyg_thread_measure_stack_usage(cyg_handle_t thread);
d397fc472bcf Merge from eCos master repository on 2001-01-05-06:43:02-GMT
jlarmour
parents: 115
diff changeset
207 #endif
10
d3fbcdfa1b2f Merge from eCos master repository on 1999-05-29-00:13:11-BST
jlarmour
parents: 8
diff changeset
208
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
209 /*---------------------------------------------------------------------------*/
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
210 /* Per-thread Data */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
211
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
212 #ifdef CYGVAR_KERNEL_THREADS_DATA
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
213
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
214 cyg_ucount32 cyg_thread_new_data_index(void);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
215
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
216 void cyg_thread_free_data_index(cyg_ucount32 index);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
217
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
218 CYG_ADDRWORD cyg_thread_get_data(cyg_ucount32 index);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
219
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
220 CYG_ADDRWORD *cyg_thread_get_data_ptr(cyg_ucount32 index);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
221
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
222 void cyg_thread_set_data(cyg_ucount32 index, CYG_ADDRWORD data);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
223
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
224 #endif
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
225
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
226 /*---------------------------------------------------------------------------*/
210
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
227 /* Thread destructors */
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
228
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
229 #ifdef CYGPKG_KERNEL_THREADS_DESTRUCTORS
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
230
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
231 typedef void (*cyg_thread_destructor_fn)(cyg_addrword_t);
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
232
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
233 cyg_bool_t cyg_thread_add_destructor( cyg_thread_destructor_fn fn,
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
234 cyg_addrword_t data );
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
235 cyg_bool_t cyg_thread_rem_destructor( cyg_thread_destructor_fn fn,
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
236 cyg_addrword_t data );
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
237 #endif
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
238
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
239 /*---------------------------------------------------------------------------*/
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
240 /* Exception handling. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
241
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
242 /* Replace current exception handler, this may apply to either the */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
243 /* current thread, or to a global exception handler. The exception */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
244 /* number may be ignored, or used to specify a particular handler. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
245
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
246 void cyg_exception_set_handler(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
247 cyg_code_t exception_number,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
248 cyg_exception_handler_t *new_handler,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
249 cyg_addrword_t new_data,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
250 cyg_exception_handler_t **old_handler,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
251 cyg_addrword_t *old_data
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
252 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
253
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
254 /* Clear exception hander to default value */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
255 void cyg_exception_clear_handler(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
256 cyg_code_t exception_number
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
257 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
258
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
259 /* Invoke exception handler */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
260 void cyg_exception_call_handler(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
261 cyg_handle_t thread,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
262 cyg_code_t exception_number,
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
263 cyg_addrword_t exception_info
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
264 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
265
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
266
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
267 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
268 /* Interrupt handling */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
269 typedef void cyg_VSR_t(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
270 typedef cyg_uint32 cyg_ISR_t(cyg_vector_t vector, cyg_addrword_t data);
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
271 typedef void cyg_DSR_t( cyg_vector_t vector,
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
272 cyg_ucount32 count,
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
273 cyg_addrword_t data);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
274
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
275
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
276 enum cyg_ISR_results
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
277 {
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
278 CYG_ISR_HANDLED = 1, /* Interrupt was handled */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
279 CYG_ISR_CALL_DSR = 2 /* Schedule DSR */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
280 };
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
281
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
282 void cyg_interrupt_create(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
283 cyg_vector_t vector, /* Vector to attach to */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
284 cyg_priority_t priority, /* Queue priority */
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
285 cyg_addrword_t data, /* Data pointer */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
286 cyg_ISR_t *isr, /* Interrupt Service Routine */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
287 cyg_DSR_t *dsr, /* Deferred Service Routine */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
288 cyg_handle_t *handle, /* returned handle */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
289 cyg_interrupt *intr /* put interrupt here */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
290 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
291
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
292 void cyg_interrupt_delete( cyg_handle_t interrupt );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
293
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
294 void cyg_interrupt_attach( cyg_handle_t interrupt );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
295
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
296 void cyg_interrupt_detach( cyg_handle_t interrupt );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
297
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
298 /* VSR manipulation */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
299
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
300 void cyg_interrupt_get_vsr(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
301 cyg_vector_t vector, /* vector to get */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
302 cyg_VSR_t **vsr /* vsr got */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
303 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
304
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
305 void cyg_interrupt_set_vsr(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
306 cyg_vector_t vector, /* vector to set */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
307 cyg_VSR_t *vsr /* vsr to set */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
308 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
309
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
310 /* CPU level interrupt mask */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
311 void cyg_interrupt_disable(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
312
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
313 void cyg_interrupt_enable(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
314
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
315 /* Interrupt controller access */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
316 void cyg_interrupt_mask(cyg_vector_t vector);
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
317 void cyg_interrupt_mask_intunsafe(cyg_vector_t vector);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
318
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
319 void cyg_interrupt_unmask(cyg_vector_t vector);
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
320 void cyg_interrupt_unmask_intunsafe(cyg_vector_t vector);
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
321
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
322 void cyg_interrupt_acknowledge(cyg_vector_t vector);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
323
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
324 void cyg_interrupt_configure(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
325 cyg_vector_t vector, /* vector to configure */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
326 cyg_bool_t level, /* level or edge triggered */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
327 cyg_bool_t up /* rising/faling edge, high/low level*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
328 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
329
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
330 void cyg_interrupt_set_cpu(
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
331 cyg_vector_t vector, /* vector to control */
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
332 cyg_cpu_t cpu /* CPU to set */
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
333 );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
334
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
335 cyg_cpu_t cyg_interrupt_get_cpu(
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
336 cyg_vector_t vector /* vector to control */
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
337 );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
338
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
339 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
340 /* Counters, Clocks and Alarms */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
341
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
342 void cyg_counter_create(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
343 cyg_handle_t *handle, /* returned counter handle */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
344 cyg_counter *counter /* put counter here */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
345 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
346
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
347 void cyg_counter_delete(cyg_handle_t counter);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
348
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
349 /* Return current value of counter */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
350 cyg_tick_count_t cyg_counter_current_value(cyg_handle_t counter);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
351
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
352 /* Set new current value */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
353 void cyg_counter_set_value(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
354 cyg_handle_t counter,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
355 cyg_tick_count_t new_value
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
356 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
357
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
358 /* Advance counter by one tick */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
359 void cyg_counter_tick(cyg_handle_t counter);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
360
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
361 /* Advance counter by multiple ticks */
215
9091c290be62 Fix build problem with new network stack
gthomas
parents: 210
diff changeset
362 void cyg_counter_multi_tick(cyg_handle_t counter, cyg_tick_count_t _ticks);
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
363
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
364
181
d61da071934c Merge from eCos master repository on 2001-08-22-06:38:55-BST
jlarmour
parents: 179
diff changeset
365 #define CYG_RESOLUTION_T_MEMBERS \
d61da071934c Merge from eCos master repository on 2001-08-22-06:38:55-BST
jlarmour
parents: 179
diff changeset
366 cyg_uint32 dividend; \
d61da071934c Merge from eCos master repository on 2001-08-22-06:38:55-BST
jlarmour
parents: 179
diff changeset
367 cyg_uint32 divisor;
d61da071934c Merge from eCos master repository on 2001-08-22-06:38:55-BST
jlarmour
parents: 179
diff changeset
368
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
369 typedef struct
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
370 {
181
d61da071934c Merge from eCos master repository on 2001-08-22-06:38:55-BST
jlarmour
parents: 179
diff changeset
371 CYG_RESOLUTION_T_MEMBERS
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
372 } cyg_resolution_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
373
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
374 /* Create a clock object */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
375 void cyg_clock_create(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
376 cyg_resolution_t resolution, /* Initial resolution */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
377 cyg_handle_t *handle, /* Returned clock handle */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
378 cyg_clock *clock /* put clock here */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
379 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
380
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
381 void cyg_clock_delete(cyg_handle_t clock);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
382
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
383 /* convert a clock handle to a counter handle so we can use the */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
384 /* counter API on it. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
385 void cyg_clock_to_counter(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
386 cyg_handle_t clock,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
387 cyg_handle_t *counter
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
388 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
389
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
390 void cyg_clock_set_resolution(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
391 cyg_handle_t clock,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
392 cyg_resolution_t resolution /* New resolution */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
393 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
394
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
395 cyg_resolution_t cyg_clock_get_resolution(cyg_handle_t clock);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
396
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
397 /* handle of real time clock */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
398 cyg_handle_t cyg_real_time_clock(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
399
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
400 /* returns value of real time clock's counter.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
401 This is the same as:
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
402 (cyg_clock_to_counter(cyg_real_time_clock(), &h),
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
403 cyg_counter_current_value(h)) */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
404 cyg_tick_count_t cyg_current_time(void);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
405
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
406 /* Alarm handler function */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
407 typedef void cyg_alarm_t(cyg_handle_t alarm, cyg_addrword_t data);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
408
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
409 void cyg_alarm_create(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
410 cyg_handle_t counter, /* Attached to this counter */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
411 cyg_alarm_t *alarmfn, /* Call-back function */
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
412 cyg_addrword_t data, /* Call-back data */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
413 cyg_handle_t *handle, /* Returned alarm object */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
414 cyg_alarm *alarm /* put alarm here */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
415 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
416
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
417 /* Disable alarm, detach from counter and invalidate handles */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
418 void cyg_alarm_delete( cyg_handle_t alarm);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
419
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
420 void cyg_alarm_initialize(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
421 cyg_handle_t alarm,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
422 cyg_tick_count_t trigger, /* Absolute trigger time */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
423 cyg_tick_count_t interval /* Relative retrigger interval */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
424 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
425
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
426 void cyg_alarm_get_times(
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
427 cyg_handle_t alarm,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
428 cyg_tick_count_t *trigger, /* Next trigger time */
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
429 cyg_tick_count_t *interval /* Current interval */
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
430 );
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 181
diff changeset
431
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
432 void cyg_alarm_enable( cyg_handle_t alarm );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
433
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
434 void cyg_alarm_disable( cyg_handle_t alarm );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
435
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
436 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
437 /* Mail boxes */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
438 void cyg_mbox_create(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
439 cyg_handle_t *handle,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
440 cyg_mbox *mbox
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
441 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
442
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
443 void cyg_mbox_delete(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
444
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
445 void *cyg_mbox_get(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
446
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
447 #ifdef CYGFUN_KERNEL_THREADS_TIMER
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
448 void *cyg_mbox_timed_get(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
449 cyg_handle_t mbox,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
450 cyg_tick_count_t abstime
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
451 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
452 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
453
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
454 void *cyg_mbox_tryget(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
455
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
456 void *cyg_mbox_peek_item(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
457
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
458 #ifdef CYGMFN_KERNEL_SYNCH_MBOXT_PUT_CAN_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
459 cyg_bool_t cyg_mbox_put(cyg_handle_t mbox, void *item);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
460 #ifdef CYGFUN_KERNEL_THREADS_TIMER
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
461 cyg_bool_t cyg_mbox_timed_put(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
462 cyg_handle_t mbox,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
463 void *item,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
464 cyg_tick_count_t abstime
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
465 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
466 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
467 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
468
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
469 cyg_bool_t cyg_mbox_tryput(cyg_handle_t mbox, void *item);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
470
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
471 cyg_count32 cyg_mbox_peek(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
472
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
473 cyg_bool_t cyg_mbox_waiting_to_get(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
474
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
475 cyg_bool_t cyg_mbox_waiting_to_put(cyg_handle_t mbox);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
476
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
477
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
478 /*-----------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
479 /* Memory pools */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
480
115
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents: 105
diff changeset
481 /* These definitions are found in the "memalloc" package as this is */
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents: 105
diff changeset
482 /* where the implementation lives. */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
483
263
c0d53837cb68 Allow configurations which have the kernel but not the memalloc
bartv
parents: 215
diff changeset
484 #ifdef CYGPKG_MEMALLOC
c0d53837cb68 Allow configurations which have the kernel but not the memalloc
bartv
parents: 215
diff changeset
485 # include <cyg/memalloc/kapi.h>
c0d53837cb68 Allow configurations which have the kernel but not the memalloc
bartv
parents: 215
diff changeset
486 #endif
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
487
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
488 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
489 /* Semaphores */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
490
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
491 void cyg_semaphore_init(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
492 cyg_sem_t *sem, /* Semaphore to init */
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
493 cyg_count32 val /* Initial semaphore value */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
494 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
495
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
496 void cyg_semaphore_destroy( cyg_sem_t *sem );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
497
115
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents: 105
diff changeset
498 cyg_bool_t cyg_semaphore_wait( cyg_sem_t *sem );
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
499
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
500 #ifdef CYGFUN_KERNEL_THREADS_TIMER
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
501 cyg_bool_t cyg_semaphore_timed_wait(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
502 cyg_sem_t *sem,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
503 cyg_tick_count_t abstime
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
504 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
505 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
506
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
507 cyg_bool_t cyg_semaphore_trywait( cyg_sem_t *sem );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
508
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
509 void cyg_semaphore_post( cyg_sem_t *sem );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
510
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
511 void cyg_semaphore_peek( cyg_sem_t *sem, cyg_count32 *val );
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
512
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
513 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
514 /* Flags */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
515
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
516 typedef cyg_uint32 cyg_flag_value_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
517 typedef cyg_uint8 cyg_flag_mode_t;
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
518 #define CYG_FLAG_WAITMODE_AND ((cyg_flag_mode_t)0) /* all bits must be set */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
519 #define CYG_FLAG_WAITMODE_OR ((cyg_flag_mode_t)2) /* any bit must be set */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
520 #define CYG_FLAG_WAITMODE_CLR ((cyg_flag_mode_t)1) /* clear when satisfied */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
521
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
522 void cyg_flag_init(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
523 cyg_flag_t *flag /* Flag to init */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
524 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
525
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
526 void cyg_flag_destroy( cyg_flag_t *flag );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
527
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
528 /* bitwise-or in the bits in value; awaken any waiting tasks whose
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
529 condition is now satisfied */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
530 void cyg_flag_setbits( cyg_flag_t *flag, cyg_flag_value_t value);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
531
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
532 /* bitwise-and with the the bits in value; this clears the bits which
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
533 are not set in value. No waiting task can be awoken. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
534 void cyg_flag_maskbits( cyg_flag_t *flag, cyg_flag_value_t value);
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
535
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
536 /* wait for the flag value to match the pattern, according to the mode.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
537 If mode includes CLR, set the flag value to zero when
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
538 our pattern is matched. The return value is that which matched
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
539 the request, or zero for an error/timeout return.
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
540 Value must not itself be zero. */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
541 cyg_flag_value_t cyg_flag_wait( cyg_flag_t *flag,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
542 cyg_flag_value_t pattern,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
543 cyg_flag_mode_t mode );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
544
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
545 #ifdef CYGFUN_KERNEL_THREADS_TIMER
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
546 cyg_flag_value_t cyg_flag_timed_wait( cyg_flag_t *flag,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
547 cyg_flag_value_t pattern,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
548 cyg_flag_mode_t mode,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
549 cyg_tick_count_t abstime );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
550
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
551 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
552
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
553 cyg_flag_value_t cyg_flag_poll( cyg_flag_t *flag,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
554 cyg_flag_value_t pattern,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
555 cyg_flag_mode_t mode );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
556
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
557 cyg_flag_value_t cyg_flag_peek( cyg_flag_t *flag );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
558
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
559 cyg_bool_t cyg_flag_waiting( cyg_flag_t *flag );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
560
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
561 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
562 /* Mutex */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
563
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
564 #ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC
179
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
565 enum cyg_mutex_protocol
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
566 {
179
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
567 CYG_MUTEX_NONE = 0, // no inversion protocol
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
568 CYG_MUTEX_INHERIT, // priority inheritance protocol
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
569 CYG_MUTEX_CEILING // priority ceiling protocol
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
570 };
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
571 #endif
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
572
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
573 void cyg_mutex_init(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
574 cyg_mutex_t *mutex /* Mutex to init */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
575 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
576
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
577 void cyg_mutex_destroy( cyg_mutex_t *mutex );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
578
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
579 cyg_bool_t cyg_mutex_lock( cyg_mutex_t *mutex );
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
580
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
581 cyg_bool_t cyg_mutex_trylock( cyg_mutex_t *mutex );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
582
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
583 void cyg_mutex_unlock( cyg_mutex_t *mutex );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
584
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
585 void cyg_mutex_release( cyg_mutex_t *mutex );
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents: 0
diff changeset
586
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
587 #ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_CEILING
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
588 void cyg_mutex_set_ceiling( cyg_mutex_t *mutex, cyg_priority_t priority );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
589 #endif
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
590
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
591 #ifdef CYGSEM_KERNEL_SYNCH_MUTEX_PRIORITY_INVERSION_PROTOCOL_DYNAMIC
179
391299f9e541 Merge from eCos master repository on 2001-08-17-16:31:54-BST
jlarmour
parents: 177
diff changeset
592 void cyg_mutex_set_protocol ( cyg_mutex_t *mutex, enum cyg_mutex_protocol protocol );
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
593 #endif
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
594
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
595 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
596 /* Condition Variables */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
597
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
598 void cyg_cond_init(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
599 cyg_cond_t *cond, /* condition variable to init */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
600 cyg_mutex_t *mutex /* associated mutex */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
601 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
602
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
603 void cyg_cond_destroy( cyg_cond_t *cond );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
604
115
6ed91473a1cd Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents: 105
diff changeset
605 cyg_bool_t cyg_cond_wait( cyg_cond_t *cond );
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
606
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
607 void cyg_cond_signal( cyg_cond_t *cond );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
608
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
609 void cyg_cond_broadcast( cyg_cond_t *cond );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
610
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
611 #ifdef CYGMFN_KERNEL_SYNCH_CONDVAR_TIMED_WAIT
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
612 cyg_bool_t cyg_cond_timed_wait(
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
613 cyg_cond_t *cond,
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
614 cyg_tick_count_t abstime
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
615 );
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
616 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
617
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
618 /*---------------------------------------------------------------------------*/
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
619 /* Spinlocks */
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
620
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
621 void cyg_spinlock_init(
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
622 cyg_spinlock_t *lock, /* spinlock to initialize */
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
623 cyg_bool_t locked /* init locked or unlocked */
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
624 );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
625
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
626 void cyg_spinlock_destroy( cyg_spinlock_t *lock );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
627
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
628 void cyg_spinlock_spin( cyg_spinlock_t *lock );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
629
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
630 void cyg_spinlock_clear( cyg_spinlock_t *lock );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
631
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
632 cyg_bool_t cyg_spinlock_try( cyg_spinlock_t *lock );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
633
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
634 cyg_bool_t cyg_spinlock_test( cyg_spinlock_t *lock );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
635
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
636 void cyg_spinlock_spin_intsave( cyg_spinlock_t *lock,
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
637 cyg_addrword_t *istate );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
638
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
639 void cyg_spinlock_clear_intsave( cyg_spinlock_t *lock,
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
640 cyg_addrword_t istate );
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
641
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
642 /*---------------------------------------------------------------------------*/
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
643 #ifdef __cplusplus
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
644 }
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
645 #endif
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
646
177
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
647 /*---------------------------------------------------------------------------*/
4c750ce71ae3 Merge from eCos master repository on 2001-08-10-19:22:57-BST
jlarmour
parents: 147
diff changeset
648
0
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
649 #include <cyg/kernel/kapidata.h>
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
650
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
651 /*---------------------------------------------------------------------------*/
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
652 /* EOF kapi.h */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
653 #endif /* CYGFUN_KERNEL_API_C */
3111d98ba7b3 Initial commit of eCos version 1.1
jlarmour
parents:
diff changeset
654 #endif /* CYGONCE_KERNEL_KAPI_H */