RTEMS  5.0.0
Macros | Functions
Serial Mouse Driver

Macros

#define SERIAL_MOUSE_DEVICE_PS2   "/dev/psaux"
 Standard device file path for a PS2 mouse device.
 
#define SERIAL_MOUSE_DRIVER_TABLE_ENTRY
 

Functions

rtems_device_driver serial_mouse_initialize (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 The initialization of the serial mouse driver. More...
 
rtems_device_driver serial_mouse_open (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 Open device driver entry point for the serial mouse driver. More...
 
rtems_device_driver serial_mouse_close (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 Close device driver entry point for the serial mouse driver. More...
 
rtems_device_driver serial_mouse_read (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 Read device driver entry point for the serial mouse driver. More...
 
rtems_device_driver serial_mouse_write (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 Write device driver entry point for the serial mouse driver. More...
 
rtems_device_driver serial_mouse_control (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
 IO Control device driver entry point for the serial mouse driver. More...
 
bool bsp_get_serial_mouse_device (const char **name, const char **type)
 Obtain serial mouse configuration information. More...
 

Detailed Description

Macro Definition Documentation

◆ SERIAL_MOUSE_DRIVER_TABLE_ENTRY

#define SERIAL_MOUSE_DRIVER_TABLE_ENTRY
Value:
rtems_device_driver serial_mouse_initialize(rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
The initialization of the serial mouse driver.
Definition: serial_mouse.c:58
rtems_device_driver serial_mouse_write(rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
Write device driver entry point for the serial mouse driver.
Definition: serial_mouse.c:152
rtems_device_driver serial_mouse_control(rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
IO Control device driver entry point for the serial mouse driver.
Definition: serial_mouse.c:162
rtems_device_driver serial_mouse_close(rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
Close device driver entry point for the serial mouse driver.
Definition: serial_mouse.c:131
rtems_device_driver serial_mouse_open(rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
Open device driver entry point for the serial mouse driver.
Definition: serial_mouse.c:79

This macro defines the serial mouse device driver entry points.

Function Documentation

◆ bsp_get_serial_mouse_device()

bool bsp_get_serial_mouse_device ( const char **  name,
const char **  type 
)

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.

Parameters
[in]namewill point to a string with the device name of the serial port with the mouse connected.
[in]typewill point to a string with the type of mouse connected.
Return values
Thismethod returns true on success and false on error.

◆ serial_mouse_close()

rtems_device_driver serial_mouse_close ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

Close device driver entry point for the serial mouse driver.

This method implements the Close device driver entry point for the serial mouse driver.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments

◆ serial_mouse_control()

rtems_device_driver serial_mouse_control ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

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.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments

◆ serial_mouse_initialize()

rtems_device_driver serial_mouse_initialize ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

The initialization of the serial mouse driver.

This method initializes the serial mouse driver.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments

◆ serial_mouse_open()

rtems_device_driver serial_mouse_open ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

Open device driver entry point for the serial mouse driver.

This method implements the Open device driver entry point for the serial mouse driver.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments

◆ serial_mouse_read()

rtems_device_driver serial_mouse_read ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

Read device driver entry point for the serial mouse driver.

This method implements the Read device driver entry point for the serial mouse driver.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments

◆ serial_mouse_write()

rtems_device_driver serial_mouse_write ( rtems_device_major_number  major,
rtems_device_minor_number  minor,
void *  arg 
)

Write device driver entry point for the serial mouse driver.

This method implements the Write device driver entry point for the serial mouse driver.

Parameters
[in]majoris the mouse device major number
[in]minoris the mouse device minor number
[in]argpoints to device driver arguments