\ ========== Copyright Header Begin ==========================================
\ Hypervisor Software File: control.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: @(#)control.fth 1.1 07/01/24
purpose: Common USB control pipe API
\ See license at end of file
: setup-buf-arg ( -- sbuf sphy slen ) setup-buf setup-buf-phys /dr ;
: cfg-buf-arg ( -- cbuf cphy ) cfg-buf cfg-buf-phys ;
: fill-setup-buf ( len idx value rtype req -- )
setup-buf dup /dr erase ( len idx value rtype req vpcbp )
tuck >dr-request c! ( len idx value rtype vpcbp )
tuck >dr-rtype c! ( len idx value vpcbp )
tuck >dr-value le-w! ( len idx vpcbp )
tuck >dr-index le-w! ( len vpcbp )
setup-buf setup-buf-phys /dr dma-sync ( )
: control-get ( adr len idx value rtype req -- actual usberr )
4 pick >r ( adr len idx value rtype req ) ( R: len )
fill-setup-buf ( adr ) ( R: len )
setup-buf-arg cfg-buf-arg r@ (control-get) ( adr actual usberr ) ( R: len )
r> drop nip nip 0 swap ( actual usberr )
-rot r> min tuck cfg-buf -rot move swap ( actual usberr )
: control-set ( adr len idx value rtype req -- usberr )
5 pick ?dup if cfg-buf 6 pick move then ( adr len idx value rtype req )
4 pick >r ( adr ) ( R: len )
fill-setup-buf drop ( ) ( R: len )
setup-buf-arg cfg-buf-arg r> (control-set) ( usberr )
: control-set-nostat ( adr len idx value rtype req -- usberr )
5 pick ?dup if cfg-buf 6 pick move then ( adr len idx value rtype req )
4 pick >r ( adr ) ( R: len )
fill-setup-buf drop ( ) ( R: len )
setup-buf-arg cfg-buf-arg r> (control-set-nostat) ( usberr )
: set-address ( dev -- usberr )
\ To get the right characteristics for dev in control-set, then normal
\ set-my-dev is nooped. We set my-dev and my-real-dev here instead.
['] set-my-dev behavior swap ( xt dev ) \ Save set-my-dev
['] noop to set-my-dev ( xt dev ) \ Make it noop
dup >r ( xt dev ) ( R: dev )
0 set-real-dev ( xt ) ( R: dev )
0 0 0 r@ DR_OUT DR_DEVICE or SET_ADDRESS control-set if
." Failed to set device address: " r> u. cr
d# 10 ms \ Let the SET_ADDRESS settle
to set-my-dev \ Restore set-my-dev
: get-desc ( adr len lang didx dtype rtype -- actual usberr )
-rot bwjoin swap DR_IN or GET_DESCRIPTOR control-get
: get-status ( adr len intf/endp rtype -- actual usberr )
0 swap DR_IN or GET_STATUS control-get
: set-config ( cfg -- usberr )
>r 0 0 0 r> DR_DEVICE DR_OUT or SET_CONFIGURATION control-set
: set-interface ( alt intf -- usberr )
0 0 2swap DR_INTERFACE DR_OUT or SET_INTERFACE control-set
: clear-feature ( intf/endp feature rtype -- usberr )
>r 0 0 2swap r> DR_OUT or CLEAR_FEATURE control-set
: set-feature ( intf/endp feature rtype -- usberr )
>r 0 0 2swap r> DR_OUT or SET_FEATURE control-set
: set-pipe-maxpayload ( size pipe -- )
: (unstall-pipe) ( pipe -- ) 0 DR_ENDPOINT clear-feature drop ;
' (unstall-pipe) to unstall-pipe
: get-cfg-desc ( adr idx -- actual )
swap >r ( idx ) ( R: adr )
r@ 9 0 3 pick CONFIGURATION DR_DEVICE get-desc nip 0= if
r> dup 2 + le-w@ rot 0 swap CONFIGURATION DR_DEVICE get-desc drop ( actual )
: get-dev-desc ( adr len -- actual )
0 0 DEVICE DR_DEVICE get-desc drop ( actual )
: (get-str-desc) ( adr len lang idx -- actual )
STRING DR_DEVICE get-desc drop ( actual )
: get-str-desc ( adr lang idx -- actual )
3dup 2 -rot (get-str-desc) 0= if 3drop 0 exit then \ Read the length
>r 2dup r> ( adr lang adr lang idx )
2 pick c@ -rot (get-str-desc) 0= if 2drop 0 exit then \ Then read the whole string
\ Copyright (c) 2006 FirmWorks
\ Permission is hereby granted, free of charge, to any person obtaining
\ a copy of this software and associated documentation files (the
\ "Software"), to deal in the Software without restriction, including
\ without limitation the rights to use, copy, modify, merge, publish,
\ distribute, sublicense, and/or sell copies of the Software, and to
\ permit persons to whom the Software is furnished to do so, subject to
\ the following conditions:
\ The above copyright notice and this permission notice shall be
\ included in all copies or substantial portions of the Software.
\ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
\ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
\ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
\ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
\ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
\ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
\ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
projects / OpenSPARC-T2-SAM / blob