\ ========== Copyright Header Begin ==========================================
\ Hypervisor Software File: fcode-rom.fth
\ Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
\ - Do no alter or remove copyright notices
\ - Redistribution and use of this software in source and binary forms, with
\ or without modification, are permitted provided that the following
\ - Redistribution of source code must retain the above copyright notice,
\ this list of conditions and the following disclaimer.
\ - Redistribution in binary form must reproduce the above copyright notice,
\ this list of conditions and the following disclaimer in the
\ documentation and/or other materials provided with the distribution.
\ Neither the name of Sun Microsystems, Inc. or the names of contributors
\ may be used to endorse or promote products derived from this software
\ without specific prior written permission.
\ This software is provided "AS IS," without a warranty of any kind.
\ ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
\ INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
\ PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
\ MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
\ ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
\ DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
\ OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
\ FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
\ DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
\ ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
\ SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
\ You acknowledge that this software is not designed, licensed or
\ intended for use in the design, construction, operation or maintenance of
\ ========== Copyright Header End ============================================
id: @(#)fcode-rom.fth 1.7 06/10/18
copyright: Copyright 1994 FirmWorks All Rights Reserved
copyright: Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
copyright: Use is subject to license terms.
\ If the expansion ROM mapped at "virt" contains an FCode program,
\ copy it into RAM and return its address
: le-w@ ( adr -- n ) dup c@ swap 1+ c@ bwjoin ;
dup 3 + c@ swap dup 2 + c@ swap dup 1 + c@ swap c@ bljoin
: fcode-image? ( PCI-struct-adr -- flag )
dup " PCIR" comp if drop false exit then
\ Check if the Vendor ID matches
dup 4 + le-w@ 0 parent-w@ <> if
\ Check if the device ID matches
dup h# 06 + le-w@ h# 02 parent-w@ <> if
\ This code can be enabled to perform a checksum test on
\ the Plugin card FCode PROM. Checksum test is performed
\ before the FCode is evaluated to make sure that the FCode
\ driver in FCode PROM is not corrupted. Checksum calculation
\ algorithm and related stuff is defined in PCI Specification
: fcode-sum-ok? ( adr len -- ok? )
over 4 + l@ < if ( h-adr ) \ h-adr: header address
drop false exit ( false ) \ length error
dup 2+ w@ swap ( exp-sum h-adr )
dup 8 + ( exp-sum h-adr b-adr ) \ b-adr: body-address
swap 4 + l@ 8 - ( exp-sum b-adr b-len ) \ b-len: body-length
bounds 0 -rot do ( exp-sum 0 )
lwsplit + lwsplit + h# ffff and ( exp-sum sum )
2dup <> if ( exp-sum sum )
" FCode checksum error; expected: %x result: %x" ( )
: release-rom-resource ( phys.hi release? -- )
\ Zero the ROM Base Address Register
\ and release associated resources
release-bar-resources ( -- )
\ disable ROMBAR address decode
dup parent-l@ 1 invert and ( phys.hi reg' )
: locate-fcode ( rom-image-adr -- false | adr len true )
dup h# 18 + le-w@ over + ( rom-image-adr PCI-struct-adr )
dup fcode-image? if ( rom-image-adr PCI-struct-adr )
drop dup rom-base - ( rom-image-adr offset )
encode-int " fcode-rom-offset" property
dup 2 + le-w@ + ( FCode-image-adr )
dup >r 4 + be-l@ ( FCode-len )
dup alloc-mem ( FCode-len adr )
swap 2dup r> -rot cmove ( adr len )
2dup fcode-sum-ok? 0= if ( adr len )
2drop false exit ( false )
dup h# 15 + c@ h# 80 and 0= ( rom-image-adr PCI-struct-adr )
while \ More images ( rom-image-adr PCI-struct-adr )
h# 10 + le-w@ 9 lshift + ( rom-image-adr' )
repeat ( rom-image-adr' )
defer skip-fcode-prom? ( -- flag ) ' false to skip-fcode-prom?
: umin ( n1 n2 -- min ) 2dup u> if swap then drop ;
: find-fcode? ( -- false | adr len true )
skip-fcode-prom? if false exit then
expansion-rom get-bar# >bar-struct >r ( -- )
r@ >bar.implemented? @ 0= if ( -- )
r> drop false exit ( -- )
\ The >bar.size element is bumped to 64 bit size
\ to take care of 64 bit pci address. We need to
\ xlsplit to get back the lower 32 bit value. The
\ upper 32 bit is zero here since we are talking about
0 0 r@ >bar.phys.hi @ r> >bar.size x@ ( 0 0 phys.hi size )
xlsplit drop h# 2.0000 umin dup >r ( 0 0 phys.hi size' )
" map-in" $call-parent ( va ) ( r: size )
\ Turn on address decode enable in Expansion ROM Base Address Register
expansion-rom >r ( va len ) ( r: offset )
r@ parent-l@ 1 or r@ parent-l! ( va len ) ( r: offset )
4 parent-w@ 2 or 4 parent-w! ( va len ) ( r: offset )
>r dup >r locate-fcode ( false | adr len true )
r> r> " map-out" $call-parent ( false | adr len true )
r> false release-rom-resource ( false | adr len true )
\ After a function has been located and a device node has been created
\ for it, fill in the device node with properties and methods.
: driver-name ( -- str len )
sub-vendev-id-value nip if \ Subsystem Ven ID is non-zero
vdss-id-value \ Use pciVVVV,DDDD.SSSS.ssss
vendev-id-value \ Use pciVVVV,DDDD
: no-builtin-fcode? ( -- flag )
builtin-drivers find-package if ( phandle )
driver-name r@ find-method if ( acf )
true true ( acf true true )
class-property-value r@ find-method if ( acf )
false true ( acf false true )
then ( acf name? true | false )
then ( acf name? true | false )
r> drop ( acf name? true | false )
catch 0= if false exit then ( false )
projects / OpenSPARC-T2-SAM / blob