consol.h File Reference

Console subsystem. More...

#include "gx_struct.h"

Macros
#define	console_init   CON_Init
#define	SYS_ConsoleInit   CON_InitEx

Functions
void	CON_EnableGecko (int channel, int safe)
	Enable or disable the USB gecko console. More...
void	CON_GetMetrics (int *cols, int *rows)
	retrieve the columns and rows of the current console More...
void	CON_GetPosition (int *cols, int *rows)
	retrieve the current cursor position of the current console More...
void	CON_Init (void *framebuffer, int xstart, int ystart, int xres, int yres, int stride)
	Initializes the console subsystem with given parameters. More...
s32	CON_InitEx (GXRModeObj *rmode, s32 conXOrigin, s32 conYOrigin, s32 conWidth, s32 conHeight)
	Initialize stdout console. More...

Detailed Description

Console subsystem.

Function Documentation

CON_EnableGecko()

CON_EnableGecko	(	int	channel,
		int	safe
	)

Enable or disable the USB gecko console.

Parameters

[in]	channel	EXI channel, or -1 �to disable the gecko console
[in]	safe	If true, use safe mode (wait for peer)

Returns

none

CON_GetMetrics()

CON_GetMetrics	(	int *	cols,
		int *	rows
	)

retrieve the columns and rows of the current console

Parameters

[out]

cols,rows

number of columns and rows of the current console

Returns

none

CON_GetPosition()

CON_GetPosition	(	int *	col,
		int *	row
	)

retrieve the current cursor position of the current console

Parameters

[out]

col,row

current cursor position

Returns

none

CON_Init()

CON_Init	(	void *	framebuffer,
		int	xstart,
		int	ystart,
		int	xres,
		int	yres,
		int	stride
	)

Initializes the console subsystem with given parameters.

Parameters

[in]	framebuffer	pointer to the framebuffer used for drawing the characters
[in]	xstart,ystart	start position of the console output in pixel
[in]	xres,yres	size of the console in pixel
[in]	stride	size of one line of the framebuffer in bytes

Returns

none

CON_InitEx()

s32 CON_InitEx	(	GXRModeObj *	rmode,
		s32	conXOrigin,
		s32	conYOrigin,
		s32	conWidth,
		s32	conHeight
	)

Initialize stdout console.

Parameters

[in]	rmode	pointer to the video/render mode configuration
[in]	conXOrigin	starting pixel in X direction of the console output on the external framebuffer
[in]	conYOrigin	starting pixel in Y direction of the console output on the external framebuffer
[in]	conWidth	width of the console output 'window' to be drawn
[in]	conHeight	height of the console output 'window' to be drawn

Returns

0 on success, <0 on error