annotate packages/io/common/current/include/devtab.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
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####
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
11 //
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 // 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
14 // 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
15 // 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
16 // http://sourceware.cygnus.com/ecos
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
17 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
18 // 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
19 // 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
20 // 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
21 // the License.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
22 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
23 // 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
24 // released September 30, 1998.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
25 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
26 // 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
27 // 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
28 // 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
29 // All Rights Reserved.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
30 // -------------------------------------------
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
31 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
32 //####COPYRIGHTEND####
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 //#####DESCRIPTIONBEGIN####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
35 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
36 // Author(s): gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
37 // Contributors: gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
38 // Date: 1999-02-04
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
39 // Purpose: Describe low level I/O interfaces.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
40 // Description:
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 //####DESCRIPTIONEND####
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 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
45
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
46 // Private include file. This file should only be used by device
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
47 // drivers, not application code.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
48
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
49 #include <pkgconf/system.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
50 #include <cyg/io/io.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
51 #include <cyg/hal/drv_api.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
52
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
53 // Set of functions which handle top level I/O functions
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
54 typedef struct {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
55 Cyg_ErrNo (*write)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
56 const void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
57 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
58 Cyg_ErrNo (*read)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
59 void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
60 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
61 Cyg_ErrNo (*get_config)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
62 cyg_uint32 key,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
63 void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
64 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
65 Cyg_ErrNo (*set_config)(cyg_io_handle_t handle,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
66 cyg_uint32 key,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
67 const void *buf,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
68 cyg_uint32 *len);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
69 } cyg_devio_table_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
70
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
71 #define DEVIO_TABLE(_l,_write,_read,_get_config,_set_config) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
72 cyg_devio_table_t _l = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
73 _write, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
74 _read, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
75 _get_config, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
76 _set_config, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
77 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
78
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
79 typedef struct cyg_devtab_entry {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
80 const char *name;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
81 const char *dep_name;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
82 cyg_devio_table_t *handlers;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
83 bool (*init)(struct cyg_devtab_entry *tab);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
84 Cyg_ErrNo (*lookup)(struct cyg_devtab_entry **tab,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
85 struct cyg_devtab_entry *sub_tab,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
86 const char *name);
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
87 void *priv;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
88 unsigned long status;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
89 } cyg_devtab_entry_t;
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 #define CYG_DEVTAB_STATUS_AVAIL 0x0001
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 extern cyg_devtab_entry_t __DEVTAB__[], __DEVTAB_END__;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
94
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
95 #define DEVTAB_ENTRY(_l,_name,_dep_name,_handlers,_init,_lookup,_priv) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
96 cyg_devtab_entry_t _l __attribute__ ((section(".devtab"))) = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
97 _name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
98 _dep_name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
99 _handlers, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
100 _init, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
101 _lookup, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
102 _priv \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
103 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
104
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
105 #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
106 cyg_devtab_entry_t _l = { \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
107 _name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
108 _dep_name, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
109 _handlers, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
110 _init, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
111 _lookup, \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
112 _priv \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
113 };
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
114
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
115 #endif // CYGONCE_IO_DEVTAB_H