1SMP_CONF_PHY_EVENT(8) SMP_UTILS SMP_CONF_PHY_EVENT(8)
2
6 smp_conf_phy_event - invoke CONFIGURE PHY EVENT function
7
9 smp_conf_phy_event [--clear] [--enumerate] [--expected=EX]
10 [--file=FILE] [--help] [--hex] [--interface=PARAMS] [--pes=PES,PES...]
11 [--phy=ID] [--raw] [--sa=SAS_ADDR] [--thres=THR,THR...] [--verbose]
12 [--version] SMP_DEVICE[,N]
13
15 Sends a SAS Serial Management Protocol (SMP) CONFIGURE PHY EVENT func‐
16 tion request to an SMP target. The SMP target is identified by the
17 SMP_DEVICE and the --sa=SAS_ADDR. Depending on the interface, the
18 SAS_ADDR may be deduced from the SMP_DEVICE. The mpt interface uses
19 SMP_DEVICE to identify a HBA (an SMP initiator) and needs the addi‐
20 tional ,N to differentiate between HBAs if there are multiple present.
21 The function request contains zero or more phy event configuration
23 descriptors. Each descriptor is 8 byte long and contains a phy event
24 source (one byte long) and optionally a peak value detector threshold
25 which is 32 bits long (4 bytes). These values can either be supplied on
26 the command line as the arguments to the --pes and --thres options, or
27 within a FILE given to the --file option.
28 Once a phy event source has been configured by this function, its coun‐
30 ters should be readable with the REPORT PHY EVENT or REPORT PHY EVENT
31 LIST functions. Peak value detector thresholds should only be non-zero
32 for phy event sources whose type is "peak value detector". If the
33 threshold value is exceeded the expander will originate a Broad‐
34 cast(Expander).
35
37 Mandatory arguments to long options are mandatory for short options as
38 well.
39 -C, --clear
41 sets the CLEAR PEAKS bit the in function request. This will
42 cause all peak value detectors associated with this phy (i.e.
43 ID) to be cleared to zero.
44 -e, --enumerate
46 enumerate all of the known Phy Event Source names, one per line
47 preceded by its value in hex. Ignores SMP_DEVICE if it is given;
48 most other options are also ignored. Exits after displaying the
49 names.
50 -E, --expected=EX
52 set the 'expected expander change count' field in the SMP
53 request. The value EX is from 0 to 65535 inclusive with 0 being
54 the default value. When EX is greater than zero then if the
55 value doesn't match the expander change count of the SMP target
56 (i.e. the expander) when the request arrives then the target
57 ignores the request and sets a function result of "invalid
58 expander change count" in the response.
59 -f, --file=FILE
61 where FILE is a file name containing pairs of values. The first
62 member of each pair is a phy event source and the second member
63 of the pair is a peak value detector threshold. Values are
64 interpreted as decimal unless prefixed by '0x' or '0X' (or it
65 has a trailing 'h' or 'H'). Everything from and including a "#"
66 on a line is ignored as are blank lines. Values may be comma,
67 space and tab separated or appear on separate lines. This
68 option cannot be present with the --pes option.
69 -h, --help
71 output the usage message then exit.
72 -H, --hex
74 output the response (less the CRC field) in hexadecimal.
75 -I, --interface=PARAMS
77 interface specific parameters. In this case "interface" refers
78 to the path through the operating system to the SMP initiator.
79 See the smp_utils man page for more information.
80 -p, --phy=ID
82 phy identifier. ID is a value between 0 and 254 (default 0).
83 -P, --pes=PES,PES...
85 where PES,PES... is a string of comma (or space) separated val‐
86 ues that are interpreted as phy event sources (each a value from
87 0 to 255). Each number is interpreted as decimal unless pre‐
88 fixed by '0x' or '0X' (or it has a trailing 'h' or 'H'). An
89 argument that contains any space separators needs to be quoted
90 (or otherwise escaped). When this option is given then the
91 --thres option may also be given and they should contain the
92 same number of elements in their arguments.
93 -r, --raw
95 send the response (less the CRC field) to stdout in binary. All
96 error messages are sent to stderr.
97 -s, --sa=SAS_ADDR
99 specifies the SAS address of the SMP target device. The mpt
100 interface needs this option and it will typically be an
101 expander's SAS address. The SAS_ADDR is in decimal but most SAS
102 addresses are shown in hexadecimal. To give a number in hexa‐
103 decimal either prefix it with '0x' or put a trailing 'h' on it.
104 -T, --thres=THR,THR...
106 where THR,THR... is a string of comma (or space) separated val‐
107 ues that are interpreted as peak value detector thresholds (each
108 a 32 bit value). Each number is interpreted as decimal unless
109 prefixed by '0x' or '0X' (or it has a trailing 'h' or 'H'). An
110 argument that contains any space separators needs to be quoted
111 (or otherwise escaped). When this option is given then the --pes
112 option must also be given and they should contain the same num‐
113 ber of elements in their arguments.
114 -v, --verbose
116 increase the verbosity of the output. Can be used multiple
117 times.
118 -V, --version
120 print the version string and then exit.
121
123 The SMP CONFIGURE PHY EVENT function was introduced in SAS-2 .
124
126 Written by Douglas Gilbert.
127
129 Report bugs to <dgilbert at interlog dot com>.
130
132 Copyright © 2011 Douglas Gilbert
133 This software is distributed under a FreeBSD license. There is NO war‐
134 ranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
135 POSE.
136
138 smp_utils, smp_rep_phy_event, smp_rep_phy_event_list
139smp_utils-0.97 December 2011 SMP_CONF_PHY_EVENT(8)