Template Version: @(#)onepager.txt 1.29 04/11/15 SMI

1. Introduction
   1.1. Project/Component Working Name:

	XVR-50 Device Bindings

   1.2. Name of Document Author/Supplier:

	Eduardo Horvath
	
   1.3. Date of This Document:

	08/28/07

   1.4. Name of Major Document Customer(s)/Consumer(s):
	1.4.1. The PAC or CPT you expect to review your project:

		HEES PAC

	1.4.2. The ARC(s) you expect to review your project:

		FWARC

	1.4.3. The Director/VP who is "Sponsoring" this project:

		mike.sanfratello@sun.com

	1.4.4. The name of your business unit:

		CSW

   1.5. Email Aliases:
    	1.5.1. Responsible Manager:	ron.bielaski@sun.com
    	1.5.2. Responsible Engineer:	yajyun.wang@sun.com
    	1.5.3. Marketing Manager:
	1.5.4. Interest List:		

2. Project Summary
   2.1. Project Description:

	Device bindings for the XVR-50 (RN50) graphics controller.

	The RN50 is a low cost 2D graphics controller from ATI.
	The drivers and FCode are developed and maintained by
	the common software graphics team.

   2.2. Risks and Assumptions:

        The binding is a template and sometimes is not completely
        consistent with the implementation.

        The binding is intended to be a living document, updated
        as necessary.

3. Business Summary
   3.1. Problem Area:

	Bindings need to be standardized to enable client programs
	to identify and access the XVR-50 display controller.

4. Technical Description:
    4.1. Details:

	This will define a set of bindings for the XVR-50 graphics
	controller.

      4.1.1  Device properties:

"name"
	Type:  Prop-endoded-string
	Contents: Standard property name, defines the device's name
	Value: "display"

"device_type"
	Type: Prop-encded-string
	Contents: Standard property name to specify the implemented interface
	Value: "display"

"compatible"
	Type: Prop-encoded-array of prop-encoded-strings
	Contents: Standard property name, defines devices with which this 
	device is compatible
	Value:  "SUNW,XVR-50"

	Implementation note:
	This device requires some device specific vendor proprietary
	initialization to be performed before it can be used. Presence
	of a "compatible" property with above specified value indicates
	that the firmware has performed the required initialization.

"reg"
        Type:     Prop-encoded-array, list of property-encoded integers
        Contents: Standard property name, defines the device's addressable
	space.  The format is determined by the parent nexus.
	Format: { phys.hi phys.mid phys.lo size.hi size.lo }	[Format for PCI bus parent.]

"character-set"
	Type:  Prop-endoded-string
	Contents: IEEE1275 Standard property for display devices, 
	specifies device's character set encoding
	Value: "ISO8859-1"			[Sample for value.]

"interrupts"
	Type:  Prop-endoded-integer-array
	Contents: IEEE1275 Standard optional property, specifies device's interrupts
	Value: 00000001


Additional standard properties will be generated by the device's parent
bus driver and will not be described here.  Please see the specification
for the parent bus for details.


      4.1.2  Device methods:

The XVR-50 driver implements the following standard methods as defined in the
Open Firmware bindings for "display" devices:

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

draw-logo	( line# addr width height -- ) 
	Calls draw-logo routine for this device.

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


The following standard Open Firmware methods are created by the terminal-emulator
support package:


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

close		( -- )
        Close this previously opened device.

selftest	( -- ?error? ) 
	Perform self-test for this device.


The following methods are created by and private to the terminal-emulator
package and should not be used otherwise.

	install
	remove
	disp-test


    4.2. Interfaces:

        Imported Interfaces :

        Interface            Classification	Comments

        "name"                  Standard	FWARC/1998/392
						(Standard IEEE 1275 property)

        "device_type"           Standard	FWARC/1998/392
						(Standard IEEE 1275 property)

        "compatible"            Standard	FWARC/1998/392
						(Standard IEEE 1275 property)

        "character-set"         Standard	FWARC/1998/392
						(Standard IEEE 1275 property)

        "interrupts"            Standard	FWARC/1998/392
						(Standard IEEE 1275 property)

	 open			Standard	FWARC/1998/392
						(Standard IEEE 1275 method)
	
	 close			Standard	FWARC/1998/392
						(Standard IEEE 1275 method)
                    
	 write			Standard	FWARC/1998/392
						(Standard IEEE 1275 method)
                    
	 draw-logo		Standard	FWARC/1998/392
						(Standard IEEE 1275 method)
                    
	 restore		Standard	FWARC/1998/392
						(Standard IEEE 1275 method)
                    
	 selftest		Standard	FWARC/1998/392
						(Optional IEEE 1275 method)
                    
	 "display"		Standard	FWARC/1998/392
						(Optional IEEE 1275 property value)
                    
        Exported Interfaces :


        "SUNW,XVR-50"	
                                Uncommitted	"compatible" property value