1 #ifndef __ALT_DEV_H__
2 #define __ALT_DEV_H__
3
4 /******************************************************************************
5 * *
6 * License Agreement *
7 * *
8 * Copyright (c) 2004 Altera Corporation, San Jose, California, USA. *
9 * All rights reserved. *
10 * *
11 * Permission is hereby granted, free of charge, to any person obtaining a *
12 * copy of this software and associated documentation files (the "Software"), *
13 * to deal in the Software without restriction, including without limitation *
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense, *
15 * and/or sell copies of the Software, and to permit persons to whom the *
16 * Software is furnished to do so, subject to the following conditions: *
17 * *
18 * The above copyright notice and this permission notice shall be included in *
19 * all copies or substantial portions of the Software. *
20 * *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
27 * DEALINGS IN THE SOFTWARE. *
28 * *
29 * *
30 * Altera does not recommend, suggest or require that this reference design *
31 * file be used in conjunction or combination with any other product. *
32 ******************************************************************************/
33
34 /******************************************************************************
35 * *
36 * THIS IS A LIBRARY READ-ONLY SOURCE FILE. DO NOT EDIT. *
37 * *
38 ******************************************************************************/
39
40 #include "system.h"
41 #include "sys/alt_llist.h"
42 #include "priv/alt_dev_llist.h"
43
44 #ifdef __cplusplus
45 extern "C"
46 {
47 #endif /* __cplusplus */
48
49 /*
50 * The value ALT_IRQ_NOT_CONNECTED is used to represent an unconnected
51 * interrupt line. It cannot evaluate to a valid interrupt number.
52 */
53
54 #define ALT_IRQ_NOT_CONNECTED (-1)
55
56 typedef struct alt_dev_s alt_dev;
57
58 struct stat;
59
60 /*
61 * The file descriptor structure definition.
62 */
63
64 typedef struct alt_fd_s
65 {
66 alt_dev* dev;
67 alt_u8* priv;
68 int fd_flags;
69 } alt_fd;
70
71 /*
72 * The device structure definition.
73 */
74
75 struct alt_dev_s {
76 alt_llist llist; /* for internal use */
77 const char* name;
78 int (*open) (alt_fd* fd, const char* name, int flags, int mode);
79 int (*close) (alt_fd* fd);
80 int (*read) (alt_fd* fd, char* ptr, int len);
81 int (*write) (alt_fd* fd, const char* ptr, int len);
82 int (*lseek) (alt_fd* fd, int ptr, int dir);
83 int (*fstat) (alt_fd* fd, struct stat* buf);
84 int (*ioctl) (alt_fd* fd, int req, void* arg);
85 };
86
87 /*
88 * Functions used to register device for access through the C standard
89 * library.
90 *
91 * The only difference between alt_dev_reg() and alt_fs_reg() is the
92 * interpretation that open() places on the device name. In the case of
93 * alt_dev_reg the device is assumed to be a particular character device,
94 * and so there must be an exact match in the name for open to succeed.
95 * In the case of alt_fs_reg() the name of the device is treated as the
96 * mount point for a directory, and so any call to open() where the name
97 * is the root of the device filename will succeed.
98 */
99
100 extern int alt_fs_reg (alt_dev* dev);
101
alt_dev_reg(alt_dev * dev)102 static ALT_INLINE int alt_dev_reg (alt_dev* dev)
103 {
104 extern alt_llist alt_dev_list;
105
106 return alt_dev_llist_insert ((alt_dev_llist*) dev, &alt_dev_list);
107 }
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif /* __ALT_DEV_H__ */
114
