framebuffer.h File Reference

Frame Buffer Device Driver for all Boards. More...

#include <rtems/io.h>

Go to the source code of this file.

Macros
#define	FRAMEBUFFER_DEVICE_NAME   "/dev/fb"
#define	FRAMEBUFFER_DEVICE_0_NAME   "/dev/fb0"
	Standard device file path of first frame buffer device.
#define	FRAME_BUFFER_DRIVER_TABLE_ENTRY

Functions
rtems_device_driver	frame_buffer_initialize (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer Initialization Entry Point.
rtems_device_driver	frame_buffer_open (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer Open Entry Point.
rtems_device_driver	frame_buffer_close (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer Close Entry Point.
rtems_device_driver	frame_buffer_read (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer Read Entry Point.
rtems_device_driver	frame_buffer_write (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer Write Entry Point.
rtems_device_driver	frame_buffer_control (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Frame Buffer IO Control Entry Point.

Detailed Description

Frame Buffer Device Driver for all Boards.

This file describes the Frame Buffer Device Driver for all boards.

Macro Definition Documentation

FRAME_BUFFER_DRIVER_TABLE_ENTRY

#define FRAME_BUFFER_DRIVER_TABLE_ENTRY

Value:

{ frame_buffer_initialize, frame_buffer_open, frame_buffer_close, \
  frame_buffer_read, frame_buffer_write, frame_buffer_control }

This macro defines the standard device driver table entry for a frame buffer device driver.

FRAMEBUFFER_DEVICE_0_NAME

#define FRAMEBUFFER_DEVICE_0_NAME   "/dev/fb0"

Standard device file path of first frame buffer device.

This device is the default frame buffer device for the Microwindows Screen Driver.

FRAMEBUFFER_DEVICE_NAME

#define FRAMEBUFFER_DEVICE_NAME   "/dev/fb"

This macro defines the standard name for the frame buffer device that is available to applications.

Function Documentation

frame_buffer_close()

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

Frame Buffer Close Entry Point.

This method closes a specific device supported by the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully closed.

frame_buffer_control()

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

Frame Buffer IO Control Entry Point.

This method performs an IO Control operation on a specific device supported by the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device driver IO control operation is successfully performed.

frame_buffer_initialize()

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

Frame Buffer Initialization Entry Point.

This method initializes the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device driver is successfully initialized.

frame_buffer_open()

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

Frame Buffer Open Entry Point.

This method opens a specific device supported by the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device driver is successfully opened.

frame_buffer_read()

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

Frame Buffer Read Entry Point.

This method reads from a specific device supported by the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully read from.

frame_buffer_write()

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

Frame Buffer Write Entry Point.

This method writes to a specific device supported by the frame buffer device driver.

Parameters

[in]	major	is the device driver major number
[in]	minor	is the device driver minor number
[in]	arg	is the parameters to this call

Returns

This method returns RTEMS_SUCCESSFUL when the device is successfully written.