console-generic.c File Reference

Generic console driver implementation. More...

#include <sys/cdefs.h>
#include <bsp.h>
#include <bsp/console-generic.h>
#include <bsp/fatal.h>
#include <rtems/bspIo.h>
#include <rtems/console.h>

Functions
rtems_device_driver	console_initialize (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console initialization entry point.
rtems_device_driver	console_open (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console open entry point.
rtems_device_driver	console_close (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console close entry point.
rtems_device_driver	console_read (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console read entry point.
rtems_device_driver	console_write (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console write entry point.
rtems_device_driver	console_control (rtems_device_major_number major, rtems_device_minor_number minor, void *arg)
	Console IO control entry point.

Variables
BSP_output_char_function_type	BSP_output_char = console_generic_char_out_init
	This function pointer references the kernel character output implementation.
BSP_polling_getchar_function_type	BSP_poll_char = console_generic_char_in
	This function pointer may reference the kernel character input implementation.

Detailed Description

Generic console driver implementation.

Function Documentation

console_close()

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

Console close entry point.

This method closes a specific device supported by the console 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

Return values

RTEMS_SUCCESSFUL

The device driver is successfully closed.

console_control()

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

Console IO control entry point.

This method performs an IO Control operation on a specific device supported by the console 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

Return values

RTEMS_SUCCESSFUL

the device driver IO control operation is successfully performed.

console_initialize()

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

Console initialization entry point.

This method initializes the console 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.

Return values

RTEMS_SUCCESSFUL

The device driver is successfully initialized.

Console initialization entry point.

Initialize all serial drivers specified in driver_context_table

Parameters

[in]	major
[in]	minor
[in]	arg

Return values

RTEMS_SUCCESSFUL

Initialization completed

This routine initializes the console IO driver.

Parameters

Parameters

major	major number
minor	minor number

Output parameters: NONE

Returns

void

console_open()

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

Console open entry point.

This method opens a specific device supported by the console 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

Return values

RTEMS_SUCCESSFUL

The device driver is successfully opened.

console_read()

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

Console read entry point.

This method reads from a specific device supported by the console 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

Return values

RTEMS_SUCCESSFUL

The device is successfully read from.

console_write()

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

Console write entry point.

This method writes to a specific device supported by the console 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

Return values

RTEMS_SUCCESSFUL

The device is successfully written.