source: rtems/cpukit/libmisc/mouse/serial_mouse.h @ e858f70

4.11
Last change on this file since e858f70 was e858f70, checked in by Joel Sherrill <joel.sherrill@…>, on Jan 10, 2013 at 11:06:06 PM

cpukit: Fix many Doxygen warnings

  • Property mode set to 100644
File size: 4.5 KB
Line 
1/**
2 * @file
3 *
4 * @brief Serial Mouse Driver
5 *
6 * This file describes the Serial Mouse Driver for all boards.
7 * This driver assumes that the BSP or application will provide
8 * an implementation of the method bsp_get_serial_mouse_device()
9 * which tells the driver what serial port device to open() and
10 * what type of mouse is connected.
11 *
12 * This driver relies on the Mouse Parser Engine.
13 */
14
15/*
16 *  COPYRIGHT (c) 1989-2011.
17 *  On-Line Applications Research Corporation (OAR).
18 *
19 *  The license and distribution terms for this file may be
20 *  found in the file LICENSE in this distribution or at
21 *  http://www.rtems.com/license/LICENSE.
22 */
23
24#ifndef __SERIAL_MOUSE_h__
25#define __SERIAL_MOUSE_h__
26
27/* functions */
28
29/**
30 *  @defgroup libmisc_serialmouse Serial Mouse Driver
31 *  @ingroup libmisc_mouse
32 */
33/**@{*/
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38/**
39 *  This macro defines the serial mouse device driver entry points.
40 */
41#define SERIAL_MOUSE_DRIVER_TABLE_ENTRY \
42  { serial_mouse_initialize, serial_mouse_open, serial_mouse_close, \
43    serial_mouse_read, serial_mouse_write, serial_mouse_control }
44
45/**
46 * @brief The initialization of the serial mouse driver.
47 *
48 * This method initializes the serial mouse driver.
49 *
50 * @param[in] major is the mouse device major number
51 * @param[in] minor is the mouse device minor number
52 * @param[in] arg points to device driver arguments
53 */
54rtems_device_driver serial_mouse_initialize(
55  rtems_device_major_number  major,
56  rtems_device_minor_number  minor,
57  void                      *arg
58);
59
60/**
61 * @brief Open device driver entry point for the serial mouse driver.
62 *
63 * This method implements the Open device driver entry
64 * point for the serial mouse driver.
65 *
66 * @param[in] major is the mouse device major number
67 * @param[in] minor is the mouse device minor number
68 * @param[in] arg points to device driver arguments
69 */
70rtems_device_driver serial_mouse_open(
71  rtems_device_major_number  major,
72  rtems_device_minor_number  minor,
73  void                      *arg
74);
75
76/**
77 * @brief Close device driver entry point for the serial mouse driver.
78 *
79 * This method implements the Close device driver entry
80 * point for the serial mouse driver.
81 *
82 * @param[in] major is the mouse device major number
83 * @param[in] minor is the mouse device minor number
84 * @param[in] arg points to device driver arguments
85 */
86rtems_device_driver serial_mouse_close(
87  rtems_device_major_number  major,
88  rtems_device_minor_number  minor,
89  void                      *arg
90);
91
92/**
93 * @brief Read device driver entry point for the serial mouse driver.
94 *
95 * This method implements the Read device driver entry
96 * point for the serial mouse driver.
97 *
98 * @param[in] major is the mouse device major number
99 * @param[in] minor is the mouse device minor number
100 * @param[in] arg points to device driver arguments
101 */
102rtems_device_driver serial_mouse_read(
103  rtems_device_major_number  major,
104  rtems_device_minor_number  minor,
105  void                      *arg
106);
107
108/**
109 * @brief Write device driver entry point for the serial mouse driver.
110 *
111 * This method implements the Write device driver entry
112 * point for the serial mouse driver.
113 *
114 * @param[in] major is the mouse device major number
115 * @param[in] minor is the mouse device minor number
116 * @param[in] arg points to device driver arguments
117 */
118rtems_device_driver serial_mouse_write(
119  rtems_device_major_number  major,
120  rtems_device_minor_number  minor,
121  void                      *arg
122);
123
124/**
125 * @brief IO Control device driver entry point for the serial mouse driver.
126 *
127 * This method implements the IO Control device driver entry
128 * point for the serial mouse driver.
129 *
130 * @param[in] major is the mouse device major number
131 * @param[in] minor is the mouse device minor number
132 * @param[in] arg points to device driver arguments
133 */
134rtems_device_driver serial_mouse_control(
135  rtems_device_major_number  major,
136  rtems_device_minor_number  minor,
137  void                      *arg
138);
139
140/**
141 * @brief Obtain serial mouse configuration information.
142 *
143 * This method is implemented by the BSP or application and
144 * tells the driver what device to open() and what type of
145 * mouse is connected.
146 *
147 * @param[in] name will point to a string with the device name
148 *            of the serial port with the mouse connected.
149 * @param[in] type will point to a string with the type of mouse connected.
150 *
151 * @retval This method returns true on success and false on error.
152 */
153bool bsp_get_serial_mouse_device(
154  const char **name,
155  const char **type
156);
157
158#ifdef __cplusplus
159}
160#endif
161/**@}*/
162#endif  /* __tty_drv__  */
Note: See TracBrowser for help on using the repository browser.