annotate packages/io/common/current/include/devtab.h @ 2:443894e2e912 ecos-v1_2_1-release

Block commit of eCos version 1.2.1
author jlarmour
date Tue, 11 May 1999 12:24:34 +0000
parents
children c38311975d4f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
1 #ifndef CYGONCE_IO_DEVTAB_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
2 #define CYGONCE_IO_DEVTAB_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
3 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
4 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
5 // devtab.h
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
6 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
7 // Device I/O Table
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
8 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
9 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
10 //####COPYRIGHTBEGIN####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
11 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
12 // -------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
13 // The contents of this file are subject to the Cygnus eCos Public License
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
14 // Version 1.0 (the "License"); you may not use this file except in
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
15 // compliance with the License. You may obtain a copy of the License at
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
16 // http://sourceware.cygnus.com/ecos
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
17 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
18 // Software distributed under the License is distributed on an "AS IS"
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
19 // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
20 // License for the specific language governing rights and limitations under
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
21 // the License.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
22 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
23 // The Original Code is eCos - Embedded Cygnus Operating System, released
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
24 // September 30, 1998.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
25 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
26 // The Initial Developer of the Original Code is Cygnus. Portions created
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
27 // by Cygnus are Copyright (C) 1998,1999 Cygnus Solutions. All Rights Reserved.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
28 // -------------------------------------------
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
29 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
30 //####COPYRIGHTEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
31 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
32 //#####DESCRIPTIONBEGIN####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
33 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
34 // Author(s): gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
35 // Contributors: gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
36 // Date: 1999-02-04
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
37 // Purpose: Describe low level I/O interfaces.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
38 // Description:
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
39 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
40 //####DESCRIPTIONEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
41 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
42 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
43
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
44 // Private include file. This file should only be used by device
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
45 // drivers, not application code.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
46
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
47 #include <pkgconf/system.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
48 #include <cyg/io/io.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
49 #include <cyg/hal/drv_api.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
50
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
51 // Set of functions which handle top level I/O functions
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
52 typedef struct {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
53 Cyg_ErrNo (*write)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
54 const void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
55 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
56 Cyg_ErrNo (*read)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
57 void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
58 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
59 Cyg_ErrNo (*get_config)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
60 cyg_uint32 key,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
61 void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
62 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
63 Cyg_ErrNo (*set_config)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
64 cyg_uint32 key,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
65 const void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
66 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
67 } cyg_devio_table_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
68
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
69 #define DEVIO_TABLE(_l,_write,_read,_get_config,_set_config) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
70 cyg_devio_table_t _l = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
71 _write, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
72 _read, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
73 _get_config, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
74 _set_config, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
75 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
76
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
77 typedef struct cyg_devtab_entry {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
78 const char *name;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
79 const char *dep_name;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
80 cyg_devio_table_t *handlers;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
81 bool (*init)(struct cyg_devtab_entry *tab);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
82 Cyg_ErrNo (*lookup)(struct cyg_devtab_entry **tab,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
83 struct cyg_devtab_entry *sub_tab,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
84 const char *name);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
85 void *priv;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
86 unsigned long status;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
87 } cyg_devtab_entry_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
88
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
89 #define CYG_DEVTAB_STATUS_AVAIL 0x0001
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
90
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
91 extern cyg_devtab_entry_t __DEVTAB__[], __DEVTAB_END__;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
92
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
93 #define DEVTAB_ENTRY(_l,_name,_dep_name,_handlers,_init,_lookup,_priv) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
94 cyg_devtab_entry_t _l __attribute__ ((section(".devtab"))) = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
95 _name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
96 _dep_name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
97 _handlers, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
98 _init, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
99 _lookup, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
100 _priv \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
101 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
102
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
103 #define DEVTAB_ENTRY_NO_INIT(_l,_name,_dep_name,_handlers,_init,_lookup,_priv) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
104 cyg_devtab_entry_t _l = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
105 _name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
106 _dep_name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
107 _handlers, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
108 _init, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
109 _lookup, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
110 _priv \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
111 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
112
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
113 #endif // CYGONCE_IO_DEVTAB_H