smp_rep_phy_event_list(8)

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

NAME

6       smp_rep_phy_event_list - invoke REPORT PHY EVENT LIST SMP function
7

SYNOPSIS

9       smp_rep_phy_event_list   [--desc]   [--enumerate]   [--force]  [--help]
10       [--hex] [--index=IN]  [--interface=PARAMS]  [--long]  [--nonz]  [--raw]
11       [--sa=SAS_ADDR] [--verbose] [--version] [--zero] SMP_DEVICE[,N]
12

DESCRIPTION

14       Sends  a  SAS  Serial  Management  Protocol (SMP) REPORT PHY EVENT LIST
15       function request to an SMP target. The SMP target is identified by  the
16       SMP_DEVICE  and  the SAS_ADDR. Depending on the interface, the SAS_ADDR
17       may be deduced from the SMP_DEVICE. The mpt interface  uses  SMP_DEVICE
18       to  identify  a  HBA  (an SMP initiator) and needs the additional ,N to
19       differentiate between HBAs if there are multiple present.
20
21       Reports zero or more phy event list descriptors. Each  descriptor  con‐
22       tains  a phy identifier, a phy event source, a phy event (i.e. a count)
23       and a peak value detector theshold. At least one phy  event  should  be
24       maintained for each phy.
25

OPTIONS

27       Mandatory  arguments to long options are mandatory for short options as
28       well.
29
30       -d, --desc
31              precede each phy event descriptor with  a  line  announcing  its
32              descriptor index number. Index numbers start at 1.
33
34       -e, --enumerate
35              enumerate  all of the known Phy Event Source names, one per line
36              preceded by its value in hex. Ignores SMP_DEVICE if it is given;
37              most  other options are also ignored. Exits after displaying the
38              names.
39
40       -f, --force
41              force the report to continue after the last descriptor index has
42              been  exceeded.  The  default action is too stop the report when
43              the last descriptor index has been exceeded.  at 1.
44
45       -h, --help
46              output the usage message then exit.
47
48       -H, --hex
49              output the response (less the CRC field) in hexadecimal.
50
51       -i, --index=IN
52              starting phy event list descriptor index. IN is a value  between
53              0  and  65535.  The  default  is 1. If IN is 0 then the response
54              should contain no phy event list descriptors but the  'last  phy
55              event  list  descriptor  index'  and  'phy event list descriptor
56              length' fields in the response should be set appropriately.  The
57              last point was clarified in SPL-2 revision 3.
58
59       -l, --long
60              prefix  each phy event source string with its numeric identifier
61              in hex.  Also place "phy_id=" in front  of  the  phy  identifier
62              number.  For example: "phy_id=3: [0x1]: Invalid word count: 29";
63              without this option this line would be: "3: Invalid word  count:
64              29".
65
66       -n, --nonz
67              only  show  phy  events with non-zero counts or peak values. The
68              default is to show all phy events in the response.
69
70       -I, --interface=PARAMS
71              interface specific parameters. In this case  "interface"  refers
72              to  the  path through the operating system to the SMP initiator.
73              See the smp_utils man page for more information.
74
75       -r, --raw
76              send the response (less the CRC field) to stdout in binary.  All
77              error messages are sent to stderr.
78
79       -s, --sa=SAS_ADDR
80              specifies  the  SAS  address of the SMP target device. Typically
81              this is an expander. This  option  may  not  be  needed  if  the
82              SMP_DEVICE  has the target's SAS address within it. The SAS_ADDR
83              is in decimal but most SAS addresses are shown  in  hexadecimal.
84              To  give  a  number in hexadecimal either prefix it with '0x' or
85              put a trailing 'h' on it.
86
87       -v, --verbose
88              increase the verbosity of the output. Can be used multiple times
89
90       -V, --version
91              print the version string and then exit.
92

NOTES

94       Similar information is maintained for SAS SSP target phys  (e.g.  on  a
95       SAS  disk). It can be obtained from the Protocol Specific Port log page
96       with the sg_logs utility.
97
98       Similar information may be obtained for SAS initiator phys (e.g.  on  a
99       SAS  HBA). As an example in Linux 2.6.28 error information can be found
100       in this directory /sys/class/sas_phy/phy-4:0 (for the phy 0 in SCSI/SAS
101       host 4).
102
103       Similar  information  may  be  obtained for SATA device phys (e.g. on a
104       SATA disk). If there is a SAT layer between OS and the SATA device then
105       the sg_sat_phy_event utility can fetch the information.
106

CONFORMING TO

108       The SMP REPORT PHY EVENT LIST function was introduced in SAS-2 .
109

AUTHORS

111       Written by Douglas Gilbert.
112

REPORTING BUGS

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

COPYRIGHT

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