============================== begin LWG_RFC ===============================

LWG_RFC00001-0 CORRECTION NOTICE

MFC functions reference nonexistent parameter

------------------------------------------------------------------------

Severity: 4 		Status: submitted	Date attained: 03/31/2006
	  		Resolution: <r>		Date resolved: <mm/dd/yy>
						Date made: <mm/dd/yy>

Summary: Several MFC functions reference a "spe_ps_addr" parameter that does 
not exist. They should reference the "speid" parameter.

Documents effected: 
	 SPE Runtime Management Library		Version: 1.1


Sections and pages effected:
	 SPE Runtime Management Library		page 26
	 Change the first Description sentence to read:

	 "The spe_read_out_mbox function returns the contents of the SPU 
	  outbound mailbox for the SPE thread specified by the speid 
	  parameter."

	 SPE Runtime Management Library		page 27
	 Change the first sentence of each of the three Description paragraphs
	 to read:

	 "The spe_stat_in_mbox function fetches the status of the SPU inbound 
	  mailbox for the SPE thread specified by the speid parameter."

	 "The spe_stat_out_mbox function fetches the status of the SPU outbound
	  mailbox for the SPE thread specified by the speid parameter."

	 "The spe_stat_out_intr_mbox function fetches the status of the SPU 
	  outbound interrupt mailbox for the SPE thread specified by the speid 
	  parameter."

	 SPE Runtime Management Library		page 28
	 Change the first Description sentence to read:

	 "The spe_write_in_mbox function places the 32-bit message specified by
	  data into the SPU inbound mailbox for the SPE thread specified by 
	  the speid parameter."

	 SPE Runtime Management Library		page 29
	 Change the first Description sentence to read:

	 "The spe_write_signal function writes data to the signal notification
	  register, specified by signal_reg, for the SPE thread specified by 
	  the speid parameter."

Submitter:	Dan Brokenshire		Date accepted: 03/31/2006
Requester:	Dan Brokenshire
Assigned to: 	Dan Brokenshire
Impact on software: None
Keywords: 	MFC, mailboxes

------------------------------------------------------------------------

Several MFC functions in the SPE Runtime Management Library describe a 
"spe_ps_addr" parameter that identifying the SPE thread in which the function
is to be performed. The parameter does not exist. Instead, the descriptions 
should be referencing the "speid" parameter. This error can be found in the 
following functions:
 - spe_read_out_mbox
 - spe_stat_in_mbox, spe_stat_out_mbox, spe_stat_out_intr_mbox
 - spe_write_in_mbox
 - spe_write_signal

=============================== end LWG_RFC ================================