\ ========== 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: OHCI USB Controller transaction processing
\ See license at end of file
: disable-control ( -- ) 10 hc-cntl-clr next-frame 0 20 ohci-reg! ;
ed-control >ed-phys l@ 20 ohci-reg! \ set HcControlHeadED
2 hc-cmd! \ mark TD added in control list
10 hc-cntl-set \ enable control list processing
: insert-control ( ed -- )
ed-control if disable-control then
: remove-control ( ed -- )
ed-control if enable-control then
\ Local temporary variables (common for control, bulk & interrupt)
\ my-dev and my-real-dev are created here to deal with set-address.
\ Normally my-dev and my-real-dev are both of the value of target.
\ However, during set-address, target=my-dev=0, my-real-dev is the
\ address to be assigned to my-real-dev. The correct path to get
\ a device's characteristics is via my-real-dev.
0 value my-dev \ Equals to target
0 value my-real-dev \ Path to device's characteristics
0 value my-dev/pipe \ Device/pipe for ED
0 value my-speed \ Speed of my-real-dev
0 value my-maxpayload \ Pipe's max payload
0 value my-buf \ Virtual address of data buffer
0 value my-buf-phys \ Physical address of data buffer
0 value /my-buf \ Size of data buffer
0 value my-td \ Current TD head
0 value my-ed \ Current ED
: set-real-dev ( real-dev target -- ) \ For set-address only
: set-normal-dev ( -- ) \ Normal operation
target dup to my-dev to my-real-dev
defer set-my-dev ' set-normal-dev to set-my-dev
: set-my-char ( pipe -- ) \ Set device's characteristics
dup 7 << my-dev or to my-dev/pipe ( pipe )
my-real-dev dup di-speed@ ( pipe dev speed )
speed-full = if ED_SPEED_FULL else ED_SPEED_LO then to my-speed
di-maxpayload@ to my-maxpayload ( )
: process-control-args ( buf phy len -- )
to /my-buf to my-buf-phys to my-buf
: alloc-control-edtds ( extra-tds -- )
/my-buf if 1+ data-timeout else nodata-timeout then to timeout
alloc-edtds to my-td to my-ed
: fill-setup-td ( sbuf sphy slen control -- )
TD_CC_NOTACCESSED or TD_DIR_SETUP or TD_INTR_OFF or TD_TOGGLE_USE_LSB0 or
my-td >hctd-control le-l!
over + 1- my-td >hctd-be le-l!
( sphy ) my-td 2dup >hctd-cbp le-l!
( sbuf ) my-td >td-cbp l!
: fill-io-tds ( td control -- )
my-buf-phys over 2dup >hctd-cbp le-l!
my-buf-phys /my-buf + 1- swap >hctd-be le-l!
: fill-control-io-tds ( dir -- std )
my-td >td-next l@ ( dir td )
/my-buf 0= if nip exit then ( dir td )
TD_CC_NOTACCESSED or TD_INTR_OFF or TD_TOGGLE_USE_LSB1 or
: fill-control-ed ( ed -- )
my-dev my-speed or ED_DIR_TD or ED_SKIP_OFF or ED_FORMAT_G or
my-maxpayload d# 16 << or
: insert-my-control ( -- )
my-ed dup fill-control-ed
: remove-my-control ( -- )
\ ---------------------------------------------------------------------------
\ CONTROL pipe operations
\ ---------------------------------------------------------------------------
: (control-get) ( sbuf sphy slen buf phy len -- actual usberr )
process-control-args ( sbuf sphy slen )
/my-buf 0= if 3drop 0 USB_ERR_INV_OP exit then
3 alloc-control-edtds ( sbuf sphy slen )
TD_ROUND_ON fill-setup-td ( )
TD_DIR_IN TD_ROUND_ON or fill-control-io-tds ( std )
TD_CC_NOTACCESSED TD_DIR_OUT or TD_INTR_MIN or TD_TOGGLE_USE_LSB1 or
swap >hctd-control le-l! ( )
\ Start control transaction
0 ( actual ) \ System error, timeout
my-td >td-next l@ dup get-actual ( td actual )
over >td-cbp l@ rot >td-pcbp l@ 2 pick dma-sync ( actual )
remove-my-control ( actual )
usb-error ( actual usberr )
: (control-set) ( sbuf sphy slen buf phy len -- usberr )
process-control-args ( sbuf sphy slen )
3 alloc-control-edtds ( sbuf sphy slen )
TD_DIR_OUT fill-control-io-tds ( std )
TD_CC_NOTACCESSED TD_DIR_IN or TD_INTR_MIN or TD_TOGGLE_USE_LSB1 or
swap >hctd-control le-l! ( )
\ Start control transaction
my-ed done? 0= if my-td error? drop then
: (control-set-nostat) ( sbuf sphy slen buf phy len -- usberr )
process-control-args ( sbuf sphy slen )
2 alloc-control-edtds ( sbuf sphy slen )
TD_DIR_OUT fill-control-io-tds drop ( )
\ Start control transaction
my-ed done? 0= if my-td error? drop then
\ 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