smp_phy_test(8)

1SMP_PHY_TEST(8)                    SMP_UTILS                   SMP_PHY_TEST(8)
2
3
4

NAME

6       smp_phy_test - invoke PHY TEST FUNTION SMP function
7

SYNOPSIS

9       smp_phy_test   [--control=CO]  [--dwords=DW]  [--expected=EX]  [--func‐
10       tion=FN]  [--help] [--hex] [--interface=PARAMS] [--linkrate=LR] [--pat‐
11       tern=PA]  [--phy=ID]  [--raw]  [--sa=SAS_ADDR]  [--verbose] [--version]
12       SMP_DEVICE[,N]
13

DESCRIPTION

15       Sends a SAS Management Protocol (SMP) PHY TEST FUNCTION  request  to  a
16       SMP  target.  The  SMP  target  is identified by the SMP_DEVICE and the
17       SAS_ADDR. Depending on the interface, the SAS_ADDR may be deduced  from
18       the  SMP_DEVICE. With one interface there is one SMP_DEVICE per machine
19       so the SMP_DEVICE,N syntax is needed to differentiate between  HBAs  if
20       there are multiple present.
21
22       The  PHY TEST FUNCTION function can be used to start and stop test pat‐
23       tern transmission. When a phy associated with a SMP target (most likely
24       an expander) starts test pattern transmission then the attached phy (if
25       there is one) sees a link down.
26
27       SAS phys associated with SSP targets (e.g. a  SAS  disk)  can  generate
28       similar  test  patterns  by using the SEND DIAGNOSTIC SCSI command with
29       page code 3fh . See the sg_senddiag utility.
30

OPTIONS

32       Mandatory arguments to long options are mandatory for short options  as
33       well.
34
35       -c, --control=CO
36              set the 'phy test pattern dwords control' field. The argument CO
37              can be from 0 to 255 inclusive, the default is 0 (each  byte  in
38              'dwords'  sent  as  data  byte (Dxx.y) without scrambling). Only
39              active when 'pattern' is set to 40h (i.e. "two_dwords").
40
41       -d, --dwords=DW
42              set the 'phy test pattern dwords' field which is 8  bytes  long.
43              The  argument DW would normally be entered in hex with a leading
44              '0x' or a trailing 'h' (otherwise it  would  be  interpreted  as
45              decimal).  Due  to a quirk in the command line parser, the argu‐
46              ment value ffffffffffffffffh (i.e. all bits sets)  needs  to  be
47              entered as '-1'.
48
49       -E, --expected=EX
50              set  the  'expected  expander  change  count'  field  in the SMP
51              request. The value EX is from 0 to 65535 inclusive with 0  being
52              the  default  value.  When  EX  is greater than zero then if the
53              value doesn't match the expander change count of the SMP  target
54              (i.e.  the  expander)  when  the request arrives then the target
55              ignores the request and  sets  a  function  result  of  "invalid
56              expander change count" in the response.
57
58       -f, --function=FN
59              set  the  'phy  test  function' field in the SMP request. Values
60              between 0 and 255 are accepted with the  default  being  0.  The
61              value  0  stops the selected phy performing a phy test function.
62              The value 1 starts the selected phy transmitting the  test  pat‐
63              tern (and anything that the phy receives is discarded).
64
65       -h, --help
66              output the usage message then exit.
67
68       -H, --hex
69              output the response in hexadecimal.
70
71       -I, --interface=PARAMS
72              interface  specific  parameters. In this case "interface" refers
73              to the path through the operating system to the  SMP  initiator.
74              See the smp_utils man page for more information.
75
76       -l, --linkrate=LR
77              transmits  the test pattern at the specified physical link rate:
78              8 -> 1.5 Gbps, 9 -> 3 Gbps, 10 -> 6 Gbps. Default value is 9.
79
80       -P, --pattern=PA
81              specifies the type of test pattern to  transmit.  SAS-2  (rev15)
82              values  are:  1  ->  JTPAT,  2  ->  CJTPAT, 10h -> TRAIN, 11h ->
83              TRAIN_DONE,  12h  ->  IDLE,   13h   ->   SCRAMBLED_0,   40h   ->
84              "two_dwords".  Default value is 2.
85
86       -p, --phy=ID
87              phy identifier. ID is a value between 0 and 127. Default is 0.
88
89       -r, --raw
90              send  the  response  to stdout in binary. All error messages are
91              sent to stderr.
92
93       -s, --sa=SAS_ADDR
94              specifies the SAS address of the SMP  target  device.  Typically
95              this  is  an  expander.  This  option  may  not be needed if the
96              SMP_DEVICE has the target's SAS address within it. The  SAS_ADDR
97              is  in  decimal but most SAS addresses are shown in hexadecimal.
98              To give a number in hexadecimal either prefix it  with  '0x'  or
99              put a trailing 'h' on it.
100
101       -v, --verbose
102              increase the verbosity of the output. Can be used multiple times
103
104       -V, --version
105              print the version string and then exit.
106

CONFORMING TO

108       The  SMP  PHY  TEST  function was introduced in SAS-1.1 and enhanced in
109       SAS-2 .
110

AUTHORS

112       Written by Douglas Gilbert.
113

REPORTING BUGS

115       Report bugs to <dgilbert at interlog dot com>.
116

COPYRIGHT

118       Copyright © 2006-2008 Douglas Gilbert
119       This software is distributed under a FreeBSD license. There is NO  war‐
120       ranty;  not  even  for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
121       POSE.
122