1 | /** |
---|
2 | * @file rtems/framebuffer.h |
---|
3 | * |
---|
4 | * This file describes the Frame Buffer Device Driver for all boards. |
---|
5 | */ |
---|
6 | |
---|
7 | /* |
---|
8 | * COPYRIGHT (c) 1989-2011. |
---|
9 | * On-Line Applications Research Corporation (OAR). |
---|
10 | * |
---|
11 | * The license and distribution terms for this file may be |
---|
12 | * found in the file LICENSE in this distribution or at |
---|
13 | * http://www.rtems.com/license/LICENSE. |
---|
14 | * |
---|
15 | * $Id$ |
---|
16 | */ |
---|
17 | |
---|
18 | #ifndef __RTEMS_FRAMEBUFFER_h__ |
---|
19 | #define __RTEMS_FRAMEBUFFER_h__ |
---|
20 | |
---|
21 | #ifdef __cplusplus |
---|
22 | extern "C" { |
---|
23 | #endif |
---|
24 | |
---|
25 | /** |
---|
26 | * This macro defines the standard name for the frame buffer device |
---|
27 | * that is available to applications. |
---|
28 | */ |
---|
29 | #define FRAMEBUFFER_DEVICE_NAME "/dev/fb" |
---|
30 | |
---|
31 | /** |
---|
32 | * This macro defines the standard device driver table entry for |
---|
33 | * a frame buffer device driver. |
---|
34 | */ |
---|
35 | #define FRAME_BUFFER_DRIVER_TABLE_ENTRY \ |
---|
36 | { frame_buffer_initialize, frame_buffer_open, frame_buffer_close, \ |
---|
37 | frame_buffer_read, frame_buffer_write, frame_buffer_control } |
---|
38 | |
---|
39 | /** |
---|
40 | * @brief Frame Buffer Initialization Entry Point |
---|
41 | * |
---|
42 | * This method initializes the frame buffer device driver. |
---|
43 | * |
---|
44 | * @param[in] major is the device driver major number |
---|
45 | * @param[in] minor is the device driver minor number |
---|
46 | * @param[in] arg is the parameters to this call |
---|
47 | * |
---|
48 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
49 | * the device driver is successfully initialized. |
---|
50 | */ |
---|
51 | rtems_device_driver frame_buffer_initialize( |
---|
52 | rtems_device_major_number major, |
---|
53 | rtems_device_minor_number minor, |
---|
54 | void *arg |
---|
55 | ); |
---|
56 | |
---|
57 | /** |
---|
58 | * @brief Frame Buffer Open Entry Point |
---|
59 | * |
---|
60 | * This method opens a specific device supported by the |
---|
61 | * frame buffer device driver. |
---|
62 | * |
---|
63 | * @param[in] major is the device driver major number |
---|
64 | * @param[in] minor is the device driver minor number |
---|
65 | * @param[in] arg is the parameters to this call |
---|
66 | * |
---|
67 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
68 | * the device driver is successfully opened. |
---|
69 | */ |
---|
70 | rtems_device_driver frame_buffer_open( |
---|
71 | rtems_device_major_number major, |
---|
72 | rtems_device_minor_number minor, |
---|
73 | void *arg |
---|
74 | ); |
---|
75 | |
---|
76 | /** |
---|
77 | * @brief Frame Buffer Close Entry Point |
---|
78 | * |
---|
79 | * This method closes a specific device supported by the |
---|
80 | * frame buffer device driver. |
---|
81 | * |
---|
82 | * @param[in] major is the device driver major number |
---|
83 | * @param[in] minor is the device driver minor number |
---|
84 | * @param[in] arg is the parameters to this call |
---|
85 | * |
---|
86 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
87 | * the device is successfully closed. |
---|
88 | */ |
---|
89 | rtems_device_driver frame_buffer_close( |
---|
90 | rtems_device_major_number major, |
---|
91 | rtems_device_minor_number minor, |
---|
92 | void *arg |
---|
93 | ); |
---|
94 | |
---|
95 | /** |
---|
96 | * @brief Frame Buffer Read Entry Point |
---|
97 | * |
---|
98 | * This method reads from a specific device supported by the |
---|
99 | * frame buffer device driver. |
---|
100 | * |
---|
101 | * @param[in] major is the device driver major number |
---|
102 | * @param[in] minor is the device driver minor number |
---|
103 | * @param[in] arg is the parameters to this call |
---|
104 | * |
---|
105 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
106 | * the device is successfully read from. |
---|
107 | */ |
---|
108 | rtems_device_driver frame_buffer_read( |
---|
109 | rtems_device_major_number major, |
---|
110 | rtems_device_minor_number minor, |
---|
111 | void *arg |
---|
112 | ); |
---|
113 | |
---|
114 | /** |
---|
115 | * @brief Frame Buffer Write Entry Point |
---|
116 | * |
---|
117 | * This method writes to a specific device supported by the |
---|
118 | * frame buffer device driver. |
---|
119 | * |
---|
120 | * @param[in] major is the device driver major number |
---|
121 | * @param[in] minor is the device driver minor number |
---|
122 | * @param[in] arg is the parameters to this call |
---|
123 | * |
---|
124 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
125 | * the device is successfully written. |
---|
126 | */ |
---|
127 | rtems_device_driver frame_buffer_write( |
---|
128 | rtems_device_major_number major, |
---|
129 | rtems_device_minor_number minor, |
---|
130 | void *arg |
---|
131 | ); |
---|
132 | |
---|
133 | /** |
---|
134 | * @brief Frame Buffer IO Control Entry Point |
---|
135 | * |
---|
136 | * This method performs an IO Control operation on a |
---|
137 | * specific device supported by the frame buffer device driver. |
---|
138 | * |
---|
139 | * @param[in] major is the device driver major number |
---|
140 | * @param[in] minor is the device driver minor number |
---|
141 | * @param[in] arg is the parameters to this call |
---|
142 | * |
---|
143 | * @return This method returns RTEMS_SUCCESSFUL when |
---|
144 | * the device driver IO control operation is |
---|
145 | * successfully performed. |
---|
146 | */ |
---|
147 | rtems_device_driver frame_buffer_control( |
---|
148 | rtems_device_major_number major, |
---|
149 | rtems_device_minor_number minor, |
---|
150 | void *arg |
---|
151 | ); |
---|
152 | |
---|
153 | #ifdef __cplusplus |
---|
154 | } |
---|
155 | #endif |
---|
156 | |
---|
157 | #endif |
---|
158 | /* end of include file */ |
---|