| camcontrol.8 (286660) | camcontrol.8 (286965) |
|---|---|
| 1.\" 2.\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" | 1.\" 2.\" Copyright (c) 1998, 1999, 2000, 2002, 2005, 2006, 2007 Kenneth D. Merry. 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright --- 11 unchanged lines hidden (view full) --- 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" |
| 28.\" $FreeBSD: head/sbin/camcontrol/camcontrol.8 286660 2015-08-12 10:34:05Z brueffer $ | 28.\" $FreeBSD: head/sbin/camcontrol/camcontrol.8 286965 2015-08-20 16:07:51Z ken $ |
| 29.\" | 29.\" |
| 30.Dd March 19, 2015 | 30.Dd August 6, 2015 |
| 31.Dt CAMCONTROL 8 32.Os 33.Sh NAME 34.Nm camcontrol 35.Nd CAM control program 36.Sh SYNOPSIS 37.Nm 38.Aq Ar command --- 209 unchanged lines hidden (view full) --- 248.Op device id 249.Op generic args 250.Op Fl l Ar level 251.Nm 252.Ic fwdownload 253.Op device id 254.Op generic args 255.Aq Fl f Ar fw_image | 31.Dt CAMCONTROL 8 32.Os 33.Sh NAME 34.Nm camcontrol 35.Nd CAM control program 36.Sh SYNOPSIS 37.Nm 38.Aq Ar command --- 209 unchanged lines hidden (view full) --- 248.Op device id 249.Op generic args 250.Op Fl l Ar level 251.Nm 252.Ic fwdownload 253.Op device id 254.Op generic args 255.Aq Fl f Ar fw_image |
| 256.Op Fl y | 256.Op Fl q |
| 257.Op Fl s | 257.Op Fl s |
| 258.Op Fl y |
|
| 258.Nm 259.Ic security 260.Op device id 261.Op generic args 262.Op Fl d Ar pwd 263.Op Fl e Ar pwd 264.Op Fl f 265.Op Fl h Ar pwd --- 40 unchanged lines hidden (view full) --- 306.Op Fl c 307.Op Fl e Ar elem_addr 308.Op Fl F Ar form1,form2 309.Op Fl p Ar part 310.Op Fl s Ar start_addr 311.Op Fl T Ar elem_type 312.Op Fl V Ar lv_num 313.Nm | 259.Nm 260.Ic security 261.Op device id 262.Op generic args 263.Op Fl d Ar pwd 264.Op Fl e Ar pwd 265.Op Fl f 266.Op Fl h Ar pwd --- 40 unchanged lines hidden (view full) --- 307.Op Fl c 308.Op Fl e Ar elem_addr 309.Op Fl F Ar form1,form2 310.Op Fl p Ar part 311.Op Fl s Ar start_addr 312.Op Fl T Ar elem_type 313.Op Fl V Ar lv_num 314.Nm |
| 315.Ic opcodes 316.Op device id 317.Op generic args 318.Op Fl o Ar opcode 319.Op Fl s Ar service_action 320.Op Fl N 321.Op Fl T 322.Nm |
|
| 314.Ic help 315.Sh DESCRIPTION 316The 317.Nm 318utility is designed to provide a way for users to access and control the 319.Fx 320CAM subsystem. 321.Pp --- 1189 unchanged lines hidden (view full) --- 1511Confirm yes to dangerous options such as 1512.Fl e 1513without prompting for confirmation 1514.El 1515.Pp 1516The password for all HPA commands is limited to 32 characters, longer passwords 1517will fail. 1518.It Ic fwdownload | 323.Ic help 324.Sh DESCRIPTION 325The 326.Nm 327utility is designed to provide a way for users to access and control the 328.Fx 329CAM subsystem. 330.Pp --- 1189 unchanged lines hidden (view full) --- 1520Confirm yes to dangerous options such as 1521.Fl e 1522without prompting for confirmation 1523.El 1524.Pp 1525The password for all HPA commands is limited to 32 characters, longer passwords 1526will fail. 1527.It Ic fwdownload |
| 1519Program firmware of the named SCSI device using the image file provided. | 1528Program firmware of the named 1529.Tn SCSI 1530or ATA device using the image file provided. |
| 1520.Pp | 1531.Pp |
| 1521Current list of supported vendors: 1522.Bl -bullet -offset indent -compact 1523.It 1524HITACHI 1525.It 1526HP 1527.It 1528IBM 1529.It 1530PLEXTOR 1531.It 1532QUANTUM 1533.It 1534SAMSUNG 1535.It 1536SEAGATE | 1532If the device is a 1533.Tn SCSI 1534device and it provides a recommended timeout for the WRITE BUFFER command 1535(see the 1536.Nm 1537opcodes subcommand), that timeout will be used for the firmware download. 1538The drive-recommended timeout value may be overridden on the command line 1539with the 1540.Fl t 1541option. 1542.Pp 1543Current list of supported vendors for SCSI/SAS drives: 1544.Bl -tag -width 10n 1545.It HGST 1546Tested with 4TB SAS drives, model number HUS724040ALS640. 1547.It HITACHI 1548.It HP 1549.It IBM 1550Tested with LTO-5 (ULTRIUM-HH5) and LTO-6 (ULTRIUM-HH6) tape drives. 1551There is a separate table entry for hard drives, because the update method 1552for hard drives is different than the method for tape drives. 1553.It PLEXTOR 1554.It QUALSTAR 1555.It QUANTUM 1556.It SAMSUNG 1557Tested with SM1625 SSDs. 1558.It SEAGATE 1559Tested with Constellation ES (ST32000444SS), ES.2 (ST33000651SS) and 1560ES.3 (ST1000NM0023) drives. 1561.It SmrtStor 1562Tested with 400GB Optimus SSDs (TXA2D20400GA6001). |
| 1537.El 1538.Pp 1539.Em WARNING! WARNING! WARNING! 1540.Pp 1541Little testing has been done to make sure that different device models from 1542each vendor work correctly with the fwdownload command. 1543A vendor name appearing in the supported list means only that firmware of at 1544least one device type from that vendor has successfully been programmed with 1545the fwdownload command. 1546Extra caution should be taken when using this command since there is no 1547guarantee it will not break a device from the listed vendors. 1548Ensure that you have a recent backup of the data on the device before 1549performing a firmware update. | 1563.El 1564.Pp 1565.Em WARNING! WARNING! WARNING! 1566.Pp 1567Little testing has been done to make sure that different device models from 1568each vendor work correctly with the fwdownload command. 1569A vendor name appearing in the supported list means only that firmware of at 1570least one device type from that vendor has successfully been programmed with 1571the fwdownload command. 1572Extra caution should be taken when using this command since there is no 1573guarantee it will not break a device from the listed vendors. 1574Ensure that you have a recent backup of the data on the device before 1575performing a firmware update. |
| 1576.Pp 1577Note that unknown 1578.Tn SCSI 1579protocol devices will not be programmed, since there is little chance of 1580the firmware download succeeding. 1581.Pp 1582.Nm 1583will currently attempt a firmware download to any 1584.Tn ATA 1585or 1586.Tn SATA 1587device, since the standard 1588.Tn ATA 1589DOWNLOAD MICROCODE command may work. 1590Firmware downloads to 1591.Tn ATA 1592and 1593.Tn SATA 1594devices are supported for devices connected 1595to standard 1596.Tn ATA 1597and 1598.Tn SATA 1599controllers, and devices connected to SAS controllers 1600with 1601.Tn SCSI 1602to 1603.Tn ATA 1604translation capability. 1605In the latter case, 1606.Nm 1607uses the 1608.Tn SCSI 1609.Tn ATA 1610PASS-THROUGH command to send the 1611.Tn ATA 1612DOWNLOAD MICROCODE command to the drive. 1613Some 1614.Tn SCSI 1615to 1616.Tn ATA 1617translation implementations don't work fully when translating 1618.Tn SCSI 1619WRITE BUFFER commands to 1620.Tn ATA 1621DOWNLOAD MICROCODE commands, but do support 1622.Tn ATA 1623passthrough well enough to do a firmware download. |
|
| 1550.Bl -tag -width 11n 1551.It Fl f Ar fw_image 1552Path to the firmware image file to be downloaded to the specified device. | 1624.Bl -tag -width 11n 1625.It Fl f Ar fw_image 1626Path to the firmware image file to be downloaded to the specified device. |
| 1553.It Fl y 1554Do not ask for confirmation. | 1627.It Fl q 1628Do not print informational messages, only print errors. 1629This option should be used with the 1630.Fl y 1631option to suppress all output. |
| 1555.It Fl s 1556Run in simulation mode. | 1632.It Fl s 1633Run in simulation mode. |
| 1557Packet sizes that will be sent are shown, but no actual packet is sent to the 1558device. 1559No confirmation is asked in simulation mode. | 1634Device checks are run and the confirmation dialog is shown, but no firmware 1635download will occur. |
| 1560.It Fl v | 1636.It Fl v |
| 1561Besides showing sense information in case of a failure, the verbose option 1562causes 1563.Nm 1564to output a line for every firmware segment that is sent to the device by the 1565fwdownload command 1566-- the same as the ones shown in simulation mode. | 1637Show 1638.Tn SCSI 1639or 1640.Tn ATA 1641errors in the event of a failure. 1642.Pp 1643In simulation mode, print out the 1644.Tn SCSI 1645CDB 1646or 1647.Tn ATA 1648register values that would be used for the firmware download command. 1649.It Fl y 1650Do not ask for confirmation. |
| 1567.El 1568.It Ic persist 1569Persistent reservation support. 1570Persistent reservations are a way to reserve a particular 1571.Tn SCSI 1572LUN for use by one or more 1573.Tn SCSI 1574initiators. --- 378 unchanged lines hidden (view full) --- 1953.Dq portal , 1954and 1955.Dq drive . 1956.El 1957.It Fl V Ar vol_num 1958Specify the number of the logical volume to operate on. 1959If the media has multiple logical volumes, this will allow displaying 1960or writing attributes on the given logical volume. | 1651.El 1652.It Ic persist 1653Persistent reservation support. 1654Persistent reservations are a way to reserve a particular 1655.Tn SCSI 1656LUN for use by one or more 1657.Tn SCSI 1658initiators. --- 378 unchanged lines hidden (view full) --- 2037.Dq portal , 2038and 2039.Dq drive . 2040.El 2041.It Fl V Ar vol_num 2042Specify the number of the logical volume to operate on. 2043If the media has multiple logical volumes, this will allow displaying 2044or writing attributes on the given logical volume. |
| 2045.It Ic opcodes 2046Issue the REPORT SUPPORTED OPCODES service action of the 2047.Tn SCSI 2048MAINTENANCE IN 2049command. 2050Without arguments, this command will return a list of all 2051.Tn SCSI 2052commands supported by the device, including service actions of commands 2053that support service actions. 2054It will also include the 2055.Tn SCSI 2056CDB (Command Data Block) length for each command, and the description of 2057each command if it is known. 2058.Bl -tag -width 18n 2059.It Fl o Ar opcode 2060Request information on a specific opcode instead of the list of supported 2061commands. 2062If supported, the target will return a CDB-like structure that indicates 2063the opcode, service action (if any), and a mask of bits that are supported 2064in that CDB. 2065.It Fl s Ar service_action 2066For commands that support a service action, specify the service action to 2067query. 2068.It Fl N 2069If a service action is specified for a given opcode, and the device does 2070not support the given service action, the device should not return a 2071.Tn SCSI 2072error, but rather indicate in the returned parameter data that the command 2073is not supported. 2074By default, if a service action is specified for an opcode, and service 2075actions are not supported for the opcode in question, the device will 2076return an error. 2077.It Fl T 2078Include timeout values. 2079This option works with the default display, which includes all commands 2080supported by the device, and with the 2081.Fl o 2082and 2083.Fl s 2084options, which request information on a specific command and service 2085action. 2086This requests that the device report Nominal and Recommended timeout values 2087for the given command or commands. 2088The timeout values are in seconds. 2089The timeout descriptor also includes a command-specific 2090.El |
|
| 1961.It Ic help 1962Print out verbose usage information. 1963.El 1964.Sh ENVIRONMENT 1965The 1966.Ev SCSI_MODES 1967variable allows the user to specify an alternate mode page format file. 1968.Pp --- 278 unchanged lines hidden --- | 2091.It Ic help 2092Print out verbose usage information. 2093.El 2094.Sh ENVIRONMENT 2095The 2096.Ev SCSI_MODES 2097variable allows the user to specify an alternate mode page format file. 2098.Pp --- 278 unchanged lines hidden --- |