Edit
openbios/openboot/obp/dev/scsi/adapters
Stefan Reinauer
- hacom.fth
-
\ ========== Copyright Header Begin ========================================== \ \ Hypervisor Software File: hacom.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 \ conditions are met: \ \ - 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 \ any nuclear facility. \ \ ========== Copyright Header End ============================================ id: @(#)hacom.fth 1.12 04/03/18 purpose: copyright: Copyright 1995-2004 Sun Microsystems, Inc. All rights reserved copyright: Use is subject to license terms. \ Common code for SCSI host adapter drivers. \ The following code is intended to be independent of the details of the \ SCSI hardware implementation. It is loaded after the hardware-dependent \ file that defines execute-command, set-address, open-hardware, etc. headers -1 instance value inq-buf \ Address of inquiry data buffer -1 instance value sense-buf \ holds extended error information -1 instance value luns-buf \ Address of report luns data buffer 0 value #retries ( -- n ) \ number of times to retry SCSI transaction h# 1.0000 constant debug-sense-codes : .buf ( strt-adr cnt -- ) base @ >r hex bounds do i c@ 3 u.r loop r> base ! ; \ Classifies the sense condition as either okay (0), retryable (1), \ or non-retryable (-1) : classify-sense ( -- 0 | 1 | -1 ) debug? debug-sense-codes and if ." Sense: " sense-buf 11 .buf ." ..." cr then sense-buf \ Make sure we understand the error class code dup c@ h# 7f and h# 70 <> if drop -1 exit then \ Check for filemark, end-of-media, or illegal block length dup 2+ c@ h# e0 and if drop -1 exit then 2 + c@ h# f and ( sense-key ) \ no_sense(0) and recoverable(1) are okay dup 1 <= if drop 0 exit then ( sense-key ) \ not-ready(2) may be retryable dup 2 = if \ check (tapes, especially) for MEDIA NOT PRESENT: if the \ media's not there the command is not retryable drop sense-buf h# c + c@ h# 3a = sense-buf h# d + c@ 0= and if -1 else 1 then exit then \ media-error(3), attention(6), and target aborted (b) are retryable \ media error really should not be retryable, but Toshiba 3601 CDROMs \ sometimes return "media error" during the spin-up process. dup 3 = over 6 = or swap 0b = or if 1 else -1 then ; external \ The SCSI device node defines an address space for its children. That \ address space is of the form "target#,unit#". target# and unit# are \ both integers. parse-2int converts a text string (e.g. "3,4") into \ a pair of binary integers. : open ( -- flag ) open-count if reopen-hardware dup if open-count 1+ to open-count then exit else open-hardware dup if 1 to open-count h# 100 dma-alloc to sense-buf h# 100 dma-alloc to inq-buf h# 2000 dma-alloc to luns-buf then then ; : close ( -- ) open-count 1- to open-count open-count if reclose-hardware else close-hardware luns-buf h# 2000 dma-free inq-buf h# 100 dma-free sense-buf h# 100 dma-free then ; headers \ REQUEST-SENSE is HA specific, here is typical implementation \ \ create sense-cmd 3 c, 0 c, 0 c, 0 c, ff c, 0 c, \ : request-sense ( buf,len -- hwresult | statbyte 0 ) \ true sense-cmd 6 execute-command \ ; \ Issue REQUEST SENSE, which is not supposed to fail : get-sense ( -- ) sense-buf ff request-sense 0= if drop then ; \ Give the device a little time to recover before retrying the command. : delay-retry ( -- ) d# 100 ms ; 0 instance value statbyte \ Local variable used by retry? \ RETRY? is used by RETRY-COMMAND to determine whether or not to retry the \ command, considering the following factors: \ - Success or failure of the command at the hardware level (failure at \ this level is usually fatal, except in the case of an incoming bus reset) \ - The value of the status byte returned by the command \ - The condition indicated by the sense bytes \ - The number of previous retries \ \ The input arguments are as returned by "scsi-exec" \ On output, the top of the stack is true if the command is to be retried, \ otherwise the top of the stack is false and the results that should be \ returned by retry-command are underneath it; those results indicate the type \ of error that occurred. : retry? ( hw-result | statbyte 0 -- true | [[sensebuf] f-hw] error? false ) case 0 of to statbyte endof \ No hardware error; continue checking bus-reset of true exit endof \ Retry after incoming bus reset ( hw-result ) true false exit \ Other hardware errors are fatal endcase statbyte 0= if false false exit then \ If successful, return "no-error" statbyte 2 and if \ "Check Condition", so get extended status get-sense classify-sense case ( -1|0|1 ) \ If the sense information says "no sense", return "no-error" 0 of false false exit endof \ If the error is fatal, return "sense-buf,valid,statbyte" -1 of sense-buf false statbyte false exit endof endcase \ Otherwise, the error was retryable. However, if we have \ have already retried the specified number of times, don't \ retry again; instead return sense buffer and status. #retries 0= if sense-buf false statbyte false exit then then \ Don't retry if vendor-unique, reserved, intermediate, or \ "condition met/good" bits are set. Return "no-sense,status" statbyte h# f5 and if true statbyte false exit then \ Don't retry if we have already retried the specified number \ of times. Return "no-sense,status" #retries 0= if true statbyte false exit then \ Otherwise, it was either a busy or a retryable check condition, \ so we retry. true ; \ RETRY-COMMAND executes a SCSI command. If a check condition is indicated, \ performs a "get-sense" command. If the sense bytes indicate a non-fatal \ condition (e.g. power-on reset occurred, not ready yet, or recoverable \ error), the command is retried until the condition either goes away or \ changes to a fatal error. \ \ The command is retried until: \ a) The command succeeds, or \ b) The select fails, or dma fails, or \ c) The sense bytes indicate an error that we can't retry at this level \ d) The number of retries is exceeded. \ #retries is number of times to retry (0: don't retry, -1: retry forever) \ \ sensebuf is the address of the sense buffer; it is present only \ if f-hw is 0 and error? is non-zero. The length of the sense buffer \ is 8 bytes plus the value in byte 7 of the sense buffer. \ \ f-hw is non-zero if there is a hardware error -- dma fails, select fails, \ etc -- or if the status byte was neither 0 (okay) nor 2 (check condition) \ \ error? is non-zero if there is a transaction error. If error? is 0, \ f-hw and sensebuf are not returned. \ \ If sensebuf is returned, the contents are valid until the next call to \ retry-command. sensebuf becomes inaccessable when this package is closed. \ \ dma-dir is necessary because it is not always possible to infer the DMA \ direction from the command. \ Local variables used by retry-command? 0 instance value dbuf \ Data transfer buffer 0 instance value dlen \ Expected length of data transfer 0 instance value direction-in \ Direction for data transfer -1 instance value cbuf \ Command base address 0 instance value clen \ Actual length of this command external : retry-command ( dma-buf dma-len dma-dir cmdbuf cmdlen #retries -- ... ) ( ... -- [[sensebuf] f-hw] error? ) to #retries to clen to cbuf to direction-in to dlen to dbuf begin dbuf dlen direction-in cbuf clen execute-command ( hwerr | stat 0 ) retry? while #retries 1- to #retries delay-retry repeat ; headers \ Collapses the complete error information returned by retry-command into \ a single error/no-error flag. : error? ( false | true true | sensebuf false true -- error? ) dup if swap 0= if nip then then ; external \ Simplified "retry-command" routine for commands with no data transfer phase \ and simple error checking requirements. : no-data-command ( cmdbuf -- error? ) >r 0 0 true r> 6 -1 retry-command error? ; \ short-data-command executes a command with the following characteristics: \ a) The data direction is incoming \ b) The data length is less than 256 bytes \ The host adapter driver is responsible for supplying the DMA data \ buffer; if the command succeeds, the buffer address is returned. \ The buffer contents become invalid when another SCSI command is \ executed, or when the driver is closed. : short-data-command ( data-len cmdbuf cmdlen -- true | buffer false ) >r >r inq-buf swap true r> r> -1 retry-command ( retry-cmd-results ) error? dup 0= if inq-buf swap then ; headers \ Here begins the implementation of "show-children", a word that \ is intended to be executed interactively, showing the user the \ devices that are attached to the SCSI bus. \ Tool for storing a big-endian 24-bit number at an unaligned address : 3c! ( n addr -- ) >r lbsplit drop r@ c! r@ 1+ c! r> 2+ c! ; \ Command block template for Inquiry command create inquiry-cmd h# 12 c, 0 c, 0 c, 0 c, ff c, 0 c, : inquiry ( -- error? ) \ 8 retries should be more than enough; inquiry commands aren't \ supposed to respond with "check condition". inq-buf ff true inquiry-cmd 6 8 retry-command error? ; : ??line ( lmargin char threshold -- ) #out @ <= if cr 2dup bl = if 1- then spaces then ; : formatted-type ( adr len -- ) #out @ -rot bounds ?do i c@ dup bl = if d# 70 ??line then d# 78 ??line emit loop drop ; \ Reads the indicated byte from the Inquiry data buffer : inq@ ( offset -- value ) inq-buf + c@ ; : .scsi1-inquiry ( -- ) inq-buf 5 ca+ 4 inq@ h# fa min formatted-type ; : .scsi2-inquiry ( -- ) inq-buf 8 ca+ d# 28 formatted-type ; headerless create report-luns-cmd h# 0c c, h# a0 c, 00 c, 00 c, 00 c, 00 c, 00 c, h# 00 c, 00 c, 20 c, 00 c, 00 c, 00 c, : report-luns ( -- error? ) luns-buf h# 2000 -1 report-luns-cmd count 8 retry-command error? ; headers \ The diagnose command is useful for generic SCSI devices. \ It executes bothe "test-unit-ready" and "send-diagnostic" \ commands, decoding the error status information they return. create test-unit-rdy-cmd 0 c, 0 c, 0 c, 0 c, 0 c, 0 c, create send-diagnostic-cmd h# 1d c, 4 c, 0 c, 0 c, 0 c, 0 c, : send-diagnostic ( -- error? ) send-diagnostic-cmd no-data-command ; external : diagnose ( -- flag ) 0 0 true test-unit-rdy-cmd 6 -1 ( dma$ dir cmd$ #retries ) retry-command if ( [ sensebuf ] hardware-error? ) ." Test unit ready failed - " ( [ sensebuf ] hardware-error? ) if ( ) ." hardware error (no such device?)" cr ( ) else ( sensebuf ) ." extended status = " cr ( sensebuf ) 8 .buf cr then true else send-diagnostic ( fail? ) then ; headers