#pragma ident	"@(#)console.txt	1.3	05/03/10 SMI"
Copyright 2004 Sun Microsystems, Inc
All Rights Reserved

Title:	sun4v virtual console device binding


1. This document describes the device binding to Open Firmware
   for the sun4v virtual console device.

   The virtual console device is a child of the "virtual-devices"
   sun4v bus node.

2. Properties

2.1. Open Firmware Defined Properties

	"reg" - standard propname defining the devices address space

		A single configuration space entry

		Note: Since this node is a 'virtual-devices'
		child node, the reg property format is defined
		by the 'virtual-devices' binding, which
		is specified by FWARC/2005/111.

	"name" - standard propname defining the device name

		Value: "console"

	"compatible" - standard propname defining driver compatibility

		Value: "SUNW,sun4v-console"

	"interrupts" - standard propname defining the interrupts

		Value - A single encoded int with the value 1

	"device_type" - standard propname defining the programming model

		Value - "serial"


3. Methods

3.1. Open Firmware Defined Methods

	open ( -- okay? ) Prepare this device for subsequent use.

	close ( -- ) Close this previously opened device.

	read ( addr len -- actual ) Read device into memory buffer;
				return actual byte count.

	write ( addr len -- actual ) Write memory buffer to device;
				return actual byte count.

	install-abort ( -- ) Begin polling for a console abort sequence.

	remove-abort ( -- ) Cease polling for a console abort sequence.

	restore ( -- ) Restore device to useable state after unexpected reset.

	ring-bell ( -- ) Ring the bell.