1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @brief Serial Mouse Driver
*
* This file describes the Serial Mouse Driver for all boards.
* This driver assumes that the BSP or application will provide
* an implementation of the method bsp_get_serial_mouse_device()
* which tells the driver what serial port device to open() and
* what type of mouse is connected.
*
* This driver relies on the Mouse Parser Engine.
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __SERIAL_MOUSE_h__
#define __SERIAL_MOUSE_h__
#include <rtems/io.h>
/* functions */
/**
* @defgroup libmisc_serialmouse Serial Mouse Driver
* @ingroup libmisc_mouse
*/
/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Standard device file path for a PS2 mouse device.
*/
#define SERIAL_MOUSE_DEVICE_PS2 "/dev/psaux"
/**
* This macro defines the serial mouse device driver entry points.
*/
#define SERIAL_MOUSE_DRIVER_TABLE_ENTRY \
{ serial_mouse_initialize, serial_mouse_open, serial_mouse_close, \
serial_mouse_read, serial_mouse_write, serial_mouse_control }
/**
* @brief The initialization of the serial mouse driver.
*
* This method initializes the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_initialize(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Open device driver entry point for the serial mouse driver.
*
* This method implements the Open device driver entry
* point for the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_open(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Close device driver entry point for the serial mouse driver.
*
* This method implements the Close device driver entry
* point for the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_close(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Read device driver entry point for the serial mouse driver.
*
* This method implements the Read device driver entry
* point for the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_read(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Write device driver entry point for the serial mouse driver.
*
* This method implements the Write device driver entry
* point for the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_write(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief IO Control device driver entry point for the serial mouse driver.
*
* This method implements the IO Control device driver entry
* point for the serial mouse driver.
*
* @param[in] major is the mouse device major number
* @param[in] minor is the mouse device minor number
* @param[in] arg points to device driver arguments
*/
rtems_device_driver serial_mouse_control(
rtems_device_major_number major,
rtems_device_minor_number minor,
void *arg
);
/**
* @brief Obtain serial mouse configuration information.
*
* This method is implemented by the BSP or application and
* tells the driver what device to open() and what type of
* mouse is connected.
*
* @param[in] name will point to a string with the device name
* of the serial port with the mouse connected.
* @param[in] type will point to a string with the type of mouse connected.
*
* @retval This method returns true on success and false on error.
*/
bool bsp_get_serial_mouse_device(
const char **name,
const char **type
);
#ifdef __cplusplus
}
#endif
/**@}*/
#endif /* __tty_drv__ */
|
