\ ========== Copyright Header Begin ==========================================
\ Hypervisor Software File: probe-reg.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: @(#)probe-reg.fth 1.16 06/11/01
purpose: PCI/UPA bus mapping
copyright: Copyright 2006 Sun Microsystems, Inc. All Rights Reserved
copyright: Use is subject to license terms.
\ Tokenizer extends bit[31] all the way to bit[63].
\ To create numbers with bit[31] set, but not extended to bit[63],
\ we need to mask out the upper 32 bits
: num-32 ( n -- l ) 0 lxjoin ;
h# 0000.1fff invert constant pci-pagemask
\ This struct has to be 64-bit aligned.
/n field >bar.phys.hi \ encoded phys.hi
/x field >bar.size \ current allocated size
/x field >bar.value \ current PA
/n field >bar.implemented?
d# 7 /bar-struct * constant /bar-data
: alloc-bar-struct ( -- ptr ) /bar-data alloc-mem ;
: free-bar-struct ( ptr -- ) /bar-data free-mem ;
\ We always need at least one of these.
alloc-bar-struct to bar-struct-addr
\ this returns an effective bar# which may be used to index into bar.struct
: get-bar# ( phys.hi -- bar# )
\ BARs 0-5 are normal. 6 is either at offset 30 or 38 (ROMBAR)
dup h# 6 > if drop 6 then ( bar# )
: >bar-struct ( bar# -- struct ) /bar-struct * bar-struct-addr + ;
: probe-l@ ( physhi -- n ) $config-l@ $call-parent ;
: probe-l! ( n physhi -- ) $config-l! $call-parent ;
: bar64? ( physhi -- flag ) cfg>ss# h# 3 and h# 3 = ;
: 64bit-pref? ( physhi -- flag ) cfg>ss# h# 43 and h# 43 = ;
: 64bit-assigned? ( ptr -- flag ) >bar.value x@ xlsplit nip 0<> ;
false value mem64-support?
\ This used to be clean.. now it is polluted with a BAR check!
\ This is there because certain PLX devices violate the PCI SPEC by
\ permitting thier IO/MEM bit to be *WRITEABLE*, so probing with -2
\ which should be safe for all BARs screws them up..
\ Wintel has a lot to answer for!
: probe-reg ( physhi -- size )
dup >r probe-l@ ( old.lo ) ( R: physhi )
r@ 4 + probe-l@ ( old.lo old.hi ) ( R: physhi )
-1 r@ 2dup probe-l! 4 + probe-l! ( old.lo old.hi ) ( R: physhi )
r@ probe-l@ r@ 4 + probe-l@ 2swap ( new.lo new.hi old.lo old.hi ) ( R: physhi )
r@ 4 + probe-l! r> probe-l! lxjoin ( new-64value )
dup >r probe-l@ ( old-value )
-1 r@ get-bar# 6 = if 1- then r@ probe-l! ( old-value )
r@ probe-l@ ( old-value new-value )
swap r> probe-l! ( new-value )
: probe-base-reg ( offset -- offset implemented? )
dup get-bar# dup >r 5 > if ( phys.hi )
\ This is a ROMBAR ( phys.hi )
2 ss#>cfg or dup probe-reg ( phys.hi bits )
pci-pagemask and ( phys.hi size' )
4 -rot ( #bytes phys.hi size' )
dup probe-l@ ( phys.hi bar-bits )
dup 1 and if ( phys.hi bar-bits )
\ I/O register ( phys.hi )
drop dup probe-reg ( phys.hi bits )
3 invert and ( phys.hi bits )
dup h# 1.8000 and h# 0.8000 = if ( phys.hi bits )
\ Some cards don't implement the
\ high bits in the I/O decoder.
h# ffff d# 16 lshift or ( phys.hi bits' )
swap 1 ss#>cfg or swap ( phys.hi size )
4 -rot ( 4 phys.hi size )
else ( phys.hi bar-bits )
\ Memory ( phys.hi bar-bits )
\ Save Bar contents for later use after this case
tuck 1 >> 3 and case ( bar-bits phys.hi )
0 of 2 ss#>cfg or 4 endof ( bar-bits phys.hi #bytes )
1 of h# 82 ss#>cfg or 4 endof ( bar-bits phys.hi #bytes )
2 of 3 ss#>cfg or 8 endof ( bar-bits phys.hi #bytes )
3 of ." BAR has reserved bits set" abort endof
endcase ( bar-bits phys.hi #bytes )
-rot ( #bytes bar-bits phys.hi )
\ If prefetchable bar, propagate into REG.
\ prefetch bit is bit 3, from the pci local bus spec
swap h# 8 and if 40 ss#>cfg or then ( #bytes phys.hi )
dup probe-reg ( #bytes phys.hi bits )
pci-pagemask and ( #bytes phys.hi bits' )
then ( #bytes phys.hi bits' )
then ( #bytes phys.hi bits' )
dup invert 1+ and ( #bytes phys.hi size )
dup invert 1+ and32 ( #bytes phys.hi size )
r> ( #bytes phys.hi size bar# )
>bar-struct ( #bytes phys.hi size adr )
over x0<> dup >r over >bar.implemented? ! ( #bytes phys.hi size adr )
debug-probe-bar? if ." ( " over .x ." )" then
tuck >bar.size x! ( #bytes phys.hi adr )
>bar.phys.hi ! ( #bytes phys.hi adr )
r> ( #bytes implemented? )
: make-power-of-2 ( n -- n' )
\ How we assign physical resource to a BAR
\ It is unfortunate that this routine can be called in 2 different
\ 1. (the normal path) As a result of normal BAR probing in which case
\ the code is executing in the child instance and we need to
\ $call-parent to do config accesses.
\ 2. (the abnormal path) As a result of a map-in at probe time that
\ exceeds the allocated resource sizes of the BAR. In which case
\ we were called by $call-parent and now need to $call-self to do
\ By duplicating the $config-X $call-who I attempted to reduce the
\ chances of someone accidently refering to the either uninitialised
\ defer or the more likely incorrectly initialised defer.
: (assign-bar-resources) ( phys.hi acf -- )
get-bar# >bar-struct >r ( -- )
r@ >bar.size dup x@ ( addr size )
make-power-of-2 tuck swap x! ( size )
r@ >bar.phys.hi @ ( size phys.hi )
cfg>ss# h# 3 and case ( -- )
0 of 3drop true endof ( true )
1 of dup pci-io-list allocate-memrange ( pa,0 | true )
dup 0= if ( pa,0 | true )
swap num-32 swap ( pa,0 )
over r@ >bar.phys.hi @ ( pa,0 pa phys.hi )
$config-l! $call-who ( pa,0 )
2 of dup pci-memlist allocate-memrange ( pa,0 | true )
dup 0= if ( pa,0 | true )
swap num-32 swap ( pa,0 )
over r@ >bar.phys.hi @ ( pa,0 pa phys.hi )
$config-l! $call-who ( pa,0 )
r@ >bar.phys.hi @ 64bit-pref? ( size 64bit-pref? )
mem64-support? and if ( size )
\ allocate from mem64 space
dup pci-mem64list allocate-memrange ( pa,0 | true )
dup 0= if ( pa,0 | true )
r@ >bar.phys.hi @ >r ( pa 0 )
over xlsplit ( pa,0 pa.lo pa.hi )
r@ 4 + $config-l! $call-who ( pa,0 pa.lo )
r> $config-l! $call-who ( pa,0 )
\ allocate from mem32 space
dup pci-memlist allocate-memrange ( pa,0 | true )
dup 0= if ( pa,0 | true )
swap num-32 swap ( pa,0 )
r@ >bar.phys.hi @ >r ( pa 0 )
over r@ $config-l! $call-who ( pa,0 )
0 r> 4 + $config-l! $call-who ( pa,0 )
\ Resource allocation problem..
." Unable to assign resources for device "
" name" my-self ihandle>phandle get-package-property
if ." <unnamed>" else type then cr
debug-probe-bar? if ." Reg: " dup >bar.phys.hi @ .x ." = " over .x cr then
true over >bar.assigned? ! ( pa ptr )
\ Called when probing, executing in child instance
: assign-bar-resources ( phys.hi -- )
['] $call-parent (assign-bar-resources)
\ Called at probe time from map-in via a $call-parent
: reassign-bar-resources ( phys.hi -- )
['] $call-self (assign-bar-resources)
\ How we release resources a BAR has been using.
: release-bar-resources ( phys.hi -- )
dup get-bar# >bar-struct >r ( phys.hi -- )
r@ >bar.assigned? @ 0= if ( phys.hi )
0 r@ >bar.assigned? ! ( phys.hi )
debug-probe-bar? if ." Releasing: BAR " dup .x ." = " then
r@ >bar.value dup x@ ( phys.hi addr pa )
r> >bar.size x@ ( phys.hi pa len )
debug-probe-bar? if over .x dup .x cr then
rot dup >r cfg>ss# 3 and ( pa len ss' ) ( R: phy.hi )
case ( pa len ) ( R: phy.hi )
1 of pci-io-list endof ( pa len list ) ( R: phy.hi )
2 of pci-memlist endof ( pa len list ) ( R: phy.hi )
r@ 64bit-pref? mem64-support? and if ( pa len ) ( R: phy.hi )
pci-mem64list ( pa len list ) ( R: phy.hi )
pci-memlist ( pa len list ) ( R: phy.hi )
endcase ( pa len list ) ( R: phy.hi )
free-memrange r> drop ( -- ) ( R: )
: read-bar-resources ( offset -- incr implemented )
debug-probe-bar? if ." read-bar-resources: " dup .x then
\ This is called for devices that are currently enabled.
\ We are much cruder here.. We set the size to the first multiple of
\ 2 that the current register address is at.
\ This is not optimal but is safe, probing an active device isn't.
dup get-bar# >bar-struct >r ( offset )
dup $config-l@ $call-parent ( phys.hi size )
over get-bar# 5 > if ( phys.hi size )
h# f ( phys.hi size mask )
dup 1 and if 3 else h# f then ( phys.hi size mask )
then ( phys.hi size mask )
invert over and ( phys.hi size size' )
dup probe-base-reg if ( phys.hi next )
swap assign-bar-resources true ( next true )
then ( offset implemented? )
r> drop ( offset implemented? )
h# 81 ss#>cfg or 4 ( phsy.hi' size )
r@ 1 rshift 3 and 2 = ( phys.hi mem64? )
if 8 3 else 4 2 then ( phys.hi size type )
r@ 8 and if h# 40 or then swap ( phys.hi type' size )
>r h# 80 or ss#>cfg or r> ( phys.hi' size )
swap r> ( size phys.hi value )
debug-probe-bar? if over .x ." @ " dup .x then
over cfg>mask and ( size phys.hi value' )
dup dup invert 1+ and ( size phys.hi value' decode )
debug-probe-bar? if ." ( " dup .x ." )" cr then
r@ >bar.size x! ( size phys.hi value' )
dup r@ >bar.value x! ( size phys.hi value' )
dup r@ >bar.assigned? ! ( size phys.hi 0? )
dup r@ >bar.implemented? ! ( size phys.hi 0? )
r> >bar.phys.hi ! ( size 0? )
: probe-and-assign-bar ( offset -- incr implemented? )
debug-probe-bar? if ." probe-and-assign-bar: " dup .x then
dup probe-base-reg if ( phys.hi next )
swap assign-bar-resources true ( next true )
debug-probe-bar? if cr then ( phys.hi next )
then ( offset implemented? )
: device-enabled? ( -- flag? ) 4 parent-w@ 7 and ;
defer build-bar-resources ( offset -- )
\ page 347 top para of PCI System Architecture
\ 3rd edition (ISBN 0-201-40993-3) states:
\ ... the configuration software will stop looking for base
\ registers in a devices header when it detects the first
\ unimplemented base register ...
\ However the PCI spec states:
\ The PCI specification Revision 2.2 states in section 6.2.5.1:
\ A type 00h predefined header has six DWORD locations allocated
\ for Base Address registers starting at offset 10h in Configuration
\ Space. A device may use any of the locations to implement
\ Base Address registers. An implemented 64-bit Base Address
\ register consumes two consecutive DWORD locations. Software looking
\ for implemented Base Address registers must start at offset 10h
\ and continue upwards through offset 24h.
: assign-addresses ( -- )
bar-struct-addr /bar-data erase ( -- )
device-enabled? if ( -- )
['] read-bar-resources ( acf )
['] probe-and-assign-bar ( acf )
then to build-bar-resources ( -- )
base-register-bounds do ( -- )
i build-bar-resources drop ( next )
expansion-rom build-bar-resources 2drop ( )
\ This routine is used to construct the "assigned-addresses" and the "reg"
\ property. The code path was so similar it wasn't worth factoring.
: make-reg-type-property ( assigned? -- xdr,len )
if h# 80 else 0 then to make-assigned? ( -- )
0 0 encode-bytes ( xdr,len )
make-assigned? 0= if ( xdr,len )
my-space en+ 0 en+ 0 en+ ( xdr,len )
i >bar-struct ( xdr,len ptr )
dup >bar.implemented? @ if ( xdr,len ptr )
dup >bar.size x@ xlsplit swap >r >r ( xdr,len ptr )
dup >bar.phys.hi @ ( xdr,len ptr phys.hi )
\ If phys.hi has ss#=3, but the bar has been actually assigned
\ 32-bit value because either the platform did not support
\ mem64 space or the bar was not prefetchable, we should
\ indicate ss#=2 in assigned-address property.
make-assigned? if ( xdr,len ptr phys.hi )
dup cfg>ss# 3 and 3 = if ( xdr,len ptr phys.hi )
over 64bit-assigned? not if ( xdr,len ptr phys.hi )
1 ss#>cfg xor ( xdr,len ptr phys.hi' )
then ( xdr,len ptr phys.hi' )
then ( xdr,len ptr phys.hi' )
then ( xdr,len ptr phys.hi' )
dup not-relocatable? make-assigned? or if ( xdr,len ptr phys.hi )
over >bar.value x@ xlsplit swap ( xdr,len ptr phys.hi phys.mid phys.lo )
else ( xdr,len ptr phys.hi )
0 0 ( xdr,len ptr phys.hi phys.mid phys.lo )
then >r >r ( xdr,len ptr phys.hi )
make-assigned? ss#>cfg or >r ( xdr,len ptr )
-rot r> r> r> r> r> encode5 rot ( xdr,len ptr )
>bar.phys.hi @ cfg>ss# ( xdr,len SS )
h# 3 and 3 <> if 1 else 2 then ( xdr,len incr )
: make-reg-property ( -- ) 0 make-reg-type-property " reg" property ;
\ We only need to decode the "reg" property if we evaluated some fcode
\ because that is the only way the reg property could be made to differ
\ We pull this stunt to permit cards that lie about thier decode ability
\ in h/w to be corrected in s/w. Certain Diamond cards are guilty of this.
: make-assigned-property ( parse? -- )
" reg" my-self ihandle>phandle ( parse? reg$ phandle )
get-package-property if drop exit then ( parse? xdr,len )
rot 0= if drop 0 then ( xdr,len' )
decode-int ( xdr,len phys.hi )
>r decode-int drop decode-int drop ( xdr,len )
decode-int >r decode-int r> lxjoin ( xdr,len len )
r> dup cfg>ss# 3 and if ( xdr,len len phys.hi )
dup get-bar# >bar-struct >r ( xdr,len len phys.hi )
r@ >bar.implemented? @ if ( xdr,len len phys.hi )
drop r@ >bar.size x@ over x< if ( xdr,len len reg-bigger? )
r@ >bar.phys.hi @ ( xdr,len len phys.hi )
dup release-bar-resources ( xdr,len len phys.hi )
swap r@ >bar.size x! ( xdr,len phys.hi )
assign-bar-resources ( xdr,len )
else ( xdr,len len phys.hi )
-1 r@ >bar.implemented? ! ( xdr,len len phys.hi )
r@ >bar.phys.hi ! ( xdr,len len )
r@ >bar.size x! ( xdr,len )
1 make-reg-type-property dup if
" assigned-addresses" property
: .dump-assigned-addr ( -- )
r@ >bar.implemented? @ r@ >bar.assigned? @ and if
r@ >bar.phys.hi @ ." Phys.hi: " .x
r@ >bar.size x@ ." size: " .x
r@ >bar.value x@ ." located: " .x cr
r> >bar.phys.hi @ cfg>ss# 3 = if 2 else 1 then
: list>property ( xdr,len list ss -- xdr,len )
swap begin ( xdr,len ss node )
dup while ( xdr,len ss node )
dup >mem.size x@ xlsplit swap >r >r ( xdr,len ss node )
dup >mem.adr x@ xlsplit swap >r >r ( xdr,len ss node )
over ss#>cfg >r ( xdr,len ss node )
>next-node @ 2swap r> r> r> r> r> encode5 2swap ( xdr,len ss node )
: make-available-property ( -- )
0 0 encode-bytes ( xdr,len )
pci-io-list @ h# 81 list>property ( xdr,len )
pci-memlist @ h# 82 list>property ( xdr,len )
pci-mem64list @ h# c3 list>property ( xdr,len )
?dup if " available" property else drop then ( )
projects / OpenSPARC-T2-SAM / blob