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 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 3. The name of the author may not be used to endorse or promote products 14.\" derived from this software without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 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$ 29.\" 30.Dd November 9, 2009 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 39.Op device id 40.Op generic args 41.Op command args 42.Nm 43.Ic devlist 44.Op Fl v 45.Nm 46.Ic periphlist 47.Op device id 48.Op Fl n Ar dev_name 49.Op Fl u Ar unit_number 50.Nm 51.Ic tur 52.Op device id 53.Op generic args 54.Nm 55.Ic inquiry 56.Op device id 57.Op generic args 58.Op Fl D 59.Op Fl S 60.Op Fl R 61.Nm 62.Ic identify 63.Op device id 64.Op generic args 65.Nm 66.Ic reportluns 67.Op device id 68.Op generic args 69.Op Fl c 70.Op Fl l 71.Op Fl r Ar reporttype 72.Nm 73.Ic readcap 74.Op device id 75.Op generic args 76.Op Fl b 77.Op Fl h 78.Op Fl H 79.Op Fl N 80.Op Fl q 81.Op Fl s 82.Nm 83.Ic start 84.Op device id 85.Op generic args 86.Nm 87.Ic stop 88.Op device id 89.Op generic args 90.Nm 91.Ic load 92.Op device id 93.Op generic args 94.Nm 95.Ic eject 96.Op device id 97.Op generic args 98.Nm 99.Ic rescan 100.Aq all | bus Ns Op :target:lun 101.Nm 102.Ic reset 103.Aq all | bus Ns Op :target:lun 104.Nm 105.Ic defects 106.Op device id 107.Op generic args 108.Aq Fl f Ar format 109.Op Fl P 110.Op Fl G 111.Nm 112.Ic modepage 113.Op device id 114.Op generic args 115.Aq Fl m Ar page | Fl l 116.Op Fl P Ar pgctl 117.Op Fl b | Fl e 118.Op Fl d 119.Nm 120.Ic cmd 121.Op device id 122.Op generic args 123.Aq Fl a Ar cmd Op args 124.Aq Fl c Ar cmd Op args 125.Op Fl i Ar len Ar fmt 126.Bk -words 127.Op Fl o Ar len Ar fmt Op args 128.Op Fl r Ar fmt 129.Ek 130.Nm 131.Ic debug 132.Op Fl I 133.Op Fl P 134.Op Fl T 135.Op Fl S 136.Op Fl X 137.Op Fl c 138.Aq all|off|bus Ns Op :target Ns Op :lun 139.Nm 140.Ic tags 141.Op device id 142.Op generic args 143.Op Fl N Ar tags 144.Op Fl q 145.Op Fl v 146.Nm 147.Ic negotiate 148.Op device id 149.Op generic args 150.Op Fl c 151.Op Fl D Ar enable|disable 152.Op Fl M Ar mode 153.Op Fl O Ar offset 154.Op Fl q 155.Op Fl R Ar syncrate 156.Op Fl T Ar enable|disable 157.Op Fl U 158.Op Fl W Ar bus_width 159.Op Fl v 160.Nm 161.Ic format 162.Op device id 163.Op generic args 164.Op Fl q 165.Op Fl r 166.Op Fl w 167.Op Fl y 168.Nm 169.Ic idle 170.Op device id 171.Op generic args 172.Op Fl t Ar time 173.Nm 174.Ic standby 175.Op device id 176.Op generic args 177.Op Fl t Ar time 178.Nm 179.Ic sleep 180.Op device id 181.Op generic args 182.Nm 183.Ic help 184.Sh DESCRIPTION 185The 186.Nm 187utility is designed to provide a way for users to access and control the 188.Fx 189CAM subsystem. 190.Pp 191The 192.Nm 193utility 194can cause a loss of data and/or system crashes if used improperly. 195Even 196expert users are encouraged to exercise caution when using this command. 197Novice users should stay away from this utility. 198.Pp 199The 200.Nm 201utility has a number of primary functions, many of which support an optional 202device identifier. 203A device identifier can take one of three forms: 204.Bl -tag -width 14n 205.It deviceUNIT 206Specify a device name and unit number combination, like "da5" or "cd3". 207Note that character device node names (e.g.\& /dev/da0) are 208.Em not 209allowed here. 210.It bus:target 211Specify a bus number and target id. 212The bus number can be determined from 213the output of 214.Dq camcontrol devlist . 215The lun defaults to 0. 216.It bus:target:lun 217Specify the bus, target and lun for a device. 218(e.g.\& 1:2:0) 219.El 220.Pp 221The device identifier, if it is specified, 222.Em must 223come immediately after the function name, and before any generic or 224function-specific arguments. 225Note that the 226.Fl n 227and 228.Fl u 229arguments described below will override any device name or unit number 230specified beforehand. 231The 232.Fl n 233and 234.Fl u 235arguments will 236.Em not 237override a specified bus:target or bus:target:lun, however. 238.Pp 239Most of the 240.Nm 241primary functions support these generic arguments: 242.Bl -tag -width 14n 243.It Fl C Ar count 244SCSI command retry count. 245In order for this to work, error recovery 246.Pq Fl E 247must be turned on. 248.It Fl E 249Instruct the kernel to perform generic SCSI error recovery for the given 250command. 251This is needed in order for the retry count 252.Pq Fl C 253to be honored. 254Other than retrying commands, the generic error recovery in 255the code will generally attempt to spin up drives that are not spinning. 256It may take some other actions, depending upon the sense code returned from 257the command. 258.It Fl n Ar dev_name 259Specify the device type to operate on, e.g.\& "da", "cd". 260.It Fl t Ar timeout 261SCSI command timeout in seconds. 262This overrides the default timeout for 263any given command. 264.It Fl u Ar unit_number 265Specify the device unit number, e.g.\& "1", "5". 266.It Fl v 267Be verbose, print out sense information for failed SCSI commands. 268.El 269.Pp 270Primary command functions: 271.Bl -tag -width periphlist 272.It Ic devlist 273List all physical devices (logical units) attached to the CAM subsystem. 274This also includes a list of peripheral drivers attached to each device. 275With the 276.Fl v 277argument, SCSI bus number, adapter name and unit numbers are printed as 278well. 279.It Ic periphlist 280List all peripheral drivers attached to a given physical device (logical 281unit). 282.It Ic tur 283Send the SCSI test unit ready (0x00) command to the given device. 284The 285.Nm 286utility will report whether the device is ready or not. 287.It Ic inquiry 288Send a SCSI inquiry command (0x12) to a device. 289By default, 290.Nm 291will print out the standard inquiry data, device serial number, and 292transfer rate information. 293The user can specify that only certain types of 294inquiry data be printed: 295.Bl -tag -width 4n 296.It Fl D 297Get the standard inquiry data. 298.It Fl S 299Print out the serial number. 300If this flag is the only one specified, 301.Nm 302will not print out "Serial Number" before the value returned by the drive. 303This is to aid in script writing. 304.It Fl R 305Print out transfer rate information. 306.El 307.It Ic identify 308Send a ATA identify command (0xec) to a device. 309.It Ic reportluns 310Send the SCSI REPORT LUNS (0xA0) command to the given device. 311By default, 312.Nm 313will print out the list of logical units (LUNs) supported by the target device. 314There are a couple of options to modify the output: 315.Bl -tag -width 14n 316.It Fl c 317Just print out a count of LUNs, not the actual LUN numbers. 318.It Fl l 319Just print out the LUNs, and don't print out the count. 320.It Fl r Ar reporttype 321Specify the type of report to request from the target: 322.Bl -tag -width 012345678 323.It default 324Return the default report. 325This is the 326.Nm 327default. 328Most targets will support this report if they support the REPORT LUNS 329command. 330.It wellknown 331Return only well known LUNs. 332.It all 333Return all available LUNs. 334.El 335.El 336.Pp 337.Nm 338will try to print out LUN numbers in a reasonable format. 339It can understand the peripheral, flat, LUN and extended LUN formats. 340.It Ic readcap 341Send the SCSI READ CAPACITY command to the given device and display 342the results. 343If the device is larger than 2TB, the SCSI READ CAPACITY (16) service 344action will be sent to obtain the full size of the device. 345By default, 346.Nm 347will print out the last logical block of the device, and the blocksize of 348the device in bytes. 349To modify the output format, use the following options: 350.Bl -tag -width 5n 351.It Fl b 352Just print out the blocksize, not the last block or device size. 353This cannot be used with 354.Fl N 355or 356.Fl s . 357.It Fl h 358Print out the device size in human readable (base 2, 1K == 1024) format. 359This implies 360.Fl N 361and cannot be used with 362.Fl q 363or 364.Fl b . 365.It Fl H 366Print out the device size in human readable (base 10, 1K == 1000) format. 367.It Fl N 368Print out the number of blocks in the device instead of the last logical 369block. 370.It Fl q 371Quiet, print out the numbers only (separated by a comma if 372.Fl b 373or 374.Fl s 375are not specified). 376.It Fl s 377Print out the last logical block or the size of the device only, and omit 378the blocksize. 379.El 380.It Ic start 381Send the SCSI Start/Stop Unit (0x1B) command to the given device with the 382start bit set. 383.It Ic stop 384Send the SCSI Start/Stop Unit (0x1B) command to the given device with the 385start bit cleared. 386.It Ic load 387Send the SCSI Start/Stop Unit (0x1B) command to the given device with the 388start bit set and the load/eject bit set. 389.It Ic eject 390Send the SCSI Start/Stop Unit (0x1B) command to the given device with the 391start bit cleared and the load/eject bit set. 392.It Ic rescan 393Tell the kernel to scan all busses in the system (with the 394.Ar all 395argument), the given bus (XPT_SCAN_BUS), or bus:target:lun 396(XPT_SCAN_LUN) for new devices or devices that have gone away. 397The user 398may specify a scan of all busses, a single bus, or a lun. 399Scanning all luns 400on a target is not supported. 401.It Ic reset 402Tell the kernel to reset all busses in the system (with the 403.Ar all 404argument) or the given bus (XPT_RESET_BUS) by issuing a SCSI bus 405reset for that bus, or to reset the given bus:target:lun 406(XPT_RESET_DEV), typically by issuing a BUS DEVICE RESET message after 407connecting to that device. 408Note that this can have a destructive impact 409on the system. 410.It Ic defects 411Send the SCSI READ DEFECT DATA (10) command (0x37) to the given device, and 412print out any combination of: the total number of defects, the primary 413defect list (PLIST), and the grown defect list (GLIST). 414.Bl -tag -width 11n 415.It Fl f Ar format 416The three format options are: 417.Em block , 418to print out the list as logical blocks, 419.Em bfi , 420to print out the list in bytes from index format, and 421.Em phys , 422to print out the list in physical sector format. 423The format argument is 424required. 425Most drives support the physical sector format. 426Some drives 427support the logical block format. 428Many drives, if they do not support the 429requested format, return the data in an alternate format, along with sense 430information indicating that the requested data format is not supported. 431The 432.Nm 433utility 434attempts to detect this, and print out whatever format the drive returns. 435If the drive uses a non-standard sense code to report that it does not 436support the requested format, 437.Nm 438will probably see the error as a failure to complete the request. 439.It Fl G 440Print out the grown defect list. 441This is a list of bad blocks that have 442been remapped since the disk left the factory. 443.It Fl P 444Print out the primary defect list. 445.El 446.Pp 447If neither 448.Fl P 449nor 450.Fl G 451is specified, 452.Nm 453will print out the number of defects given in the READ DEFECT DATA header 454returned from the drive. 455.It Ic modepage 456Allows the user to display and optionally edit a SCSI mode page. 457The mode 458page formats are located in 459.Pa /usr/share/misc/scsi_modes . 460This can be overridden by specifying a different file in the 461.Ev SCSI_MODES 462environment variable. 463The 464.Ic modepage 465command takes several arguments: 466.Bl -tag -width 12n 467.It Fl d 468Disable block descriptors for mode sense. 469.It Fl b 470Displays mode page data in binary format. 471.It Fl e 472This flag allows the user to edit values in the mode page. 473The user may 474either edit mode page values with the text editor pointed to by his 475.Ev EDITOR 476environment variable, or supply mode page values via standard input, using 477the same format that 478.Nm 479uses to display mode page values. 480The editor will be invoked if 481.Nm 482detects that standard input is terminal. 483.It Fl l 484Lists all available mode pages. 485.It Fl m Ar mode_page 486This specifies the number of the mode page the user would like to view 487and/or edit. 488This argument is mandatory unless 489.Fl l 490is specified. 491.It Fl P Ar pgctl 492This allows the user to specify the page control field. 493Possible values are: 494.Bl -tag -width xxx -compact 495.It 0 496Current values 497.It 1 498Changeable values 499.It 2 500Default values 501.It 3 502Saved values 503.El 504.El 505.It Ic cmd 506Allows the user to send an arbitrary ATA or SCSI CDB to any device. 507The 508.Ic cmd 509function requires the 510.Fl c 511argument to specify SCSI CDB or the 512.Fl a 513argument to specify ATA Command Block registers values. 514Other arguments are optional, depending on 515the command type. 516The command and data specification syntax is documented 517in 518.Xr cam_cdbparse 3 . 519NOTE: If the CDB specified causes data to be transfered to or from the 520SCSI device in question, you MUST specify either 521.Fl i 522or 523.Fl o . 524.Bl -tag -width 17n 525.It Fl a Ar cmd Op args 526This specifies the content of 12 ATA Command Block registers (command, 527features, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp. 528lba_high_exp, features_exp, sector_count, sector_count_exp). 529.It Fl c Ar cmd Op args 530This specifies the SCSI CDB. 531SCSI CDBs may be 6, 10, 12 or 16 bytes. 532.It Fl i Ar len Ar fmt 533This specifies the amount of data to read, and how it should be displayed. 534If the format is 535.Sq - , 536.Ar len 537bytes of data will be read from the device and written to standard output. 538.It Fl o Ar len Ar fmt Op args 539This specifies the amount of data to be written to a device, and the data 540that is to be written. 541If the format is 542.Sq - , 543.Ar len 544bytes of data will be read from standard input and written to the device. 545.It Fl r Ar fmt 546This specifies that 11 result ATA Command Block registers should be displayed 547(status, error, lba_low, lba_mid, lba_high, device, lba_low_exp, lba_mid_exp, 548lba_high_exp, sector_count, sector_count_exp), and how. 549If the format is 550.Sq - , 55111 result registers will be written to standard output in hex. 552.El 553.It Ic debug 554Turn on CAM debugging printfs in the kernel. 555This requires options CAMDEBUG 556in your kernel config file. 557WARNING: enabling debugging printfs currently 558causes an EXTREME number of kernel printfs. 559You may have difficulty 560turning off the debugging printfs once they start, since the kernel will be 561busy printing messages and unable to service other requests quickly. 562The 563.Ic debug 564function takes a number of arguments: 565.Bl -tag -width 18n 566.It Fl I 567Enable CAM_DEBUG_INFO printfs. 568.It Fl P 569Enable CAM_DEBUG_PERIPH printfs. 570.It Fl T 571Enable CAM_DEBUG_TRACE printfs. 572.It Fl S 573Enable CAM_DEBUG_SUBTRACE printfs. 574.It Fl X 575Enable CAM_DEBUG_XPT printfs. 576.It Fl c 577Enable CAM_DEBUG_CDB printfs. 578This will cause the kernel to print out the 579SCSI CDBs sent to the specified device(s). 580.It all 581Enable debugging for all devices. 582.It off 583Turn off debugging for all devices 584.It bus Ns Op :target Ns Op :lun 585Turn on debugging for the given bus, target or lun. 586If the lun or target 587and lun are not specified, they are wildcarded. 588(i.e., just specifying a 589bus turns on debugging printfs for all devices on that bus.) 590.El 591.It Ic tags 592Show or set the number of "tagged openings" or simultaneous transactions 593we attempt to queue to a particular device. 594By default, the 595.Ic tags 596command, with no command-specific arguments (i.e., only generic arguments) 597prints out the "soft" maximum number of transactions that can be queued to 598the device in question. 599For more detailed information, use the 600.Fl v 601argument described below. 602.Bl -tag -width 7n 603.It Fl N Ar tags 604Set the number of tags for the given device. 605This must be between the 606minimum and maximum number set in the kernel quirk table. 607The default for 608most devices that support tagged queueing is a minimum of 2 and a maximum 609of 255. 610The minimum and maximum values for a given device may be 611determined by using the 612.Fl v 613switch. 614The meaning of the 615.Fl v 616switch for this 617.Nm 618subcommand is described below. 619.It Fl q 620Be quiet, and do not report the number of tags. 621This is generally used when 622setting the number of tags. 623.It Fl v 624The verbose flag has special functionality for the 625.Em tags 626argument. 627It causes 628.Nm 629to print out the tagged queueing related fields of the XPT_GDEV_TYPE CCB: 630.Bl -tag -width 13n 631.It dev_openings 632This is the amount of capacity for transactions queued to a given device. 633.It dev_active 634This is the number of transactions currently queued to a device. 635.It devq_openings 636This is the kernel queue space for transactions. 637This count usually mirrors 638dev_openings except during error recovery operations when 639the device queue is frozen (device is not allowed to receive 640commands), the number of dev_openings is reduced, or transaction 641replay is occurring. 642.It devq_queued 643This is the number of transactions waiting in the kernel queue for capacity 644on the device. 645This number is usually zero unless error recovery is in 646progress. 647.It held 648The held count is the number of CCBs held by peripheral drivers that have 649either just been completed or are about to be released to the transport 650layer for service by a device. 651Held CCBs reserve capacity on a given 652device. 653.It mintags 654This is the current "hard" minimum number of transactions that can be 655queued to a device at once. 656The 657.Ar dev_openings 658value above cannot go below this number. 659The default value for 660.Ar mintags 661is 2, although it may be set higher or lower for various devices. 662.It maxtags 663This is the "hard" maximum number of transactions that can be queued to a 664device at one time. 665The 666.Ar dev_openings 667value cannot go above this number. 668The default value for 669.Ar maxtags 670is 255, although it may be set higher or lower for various devices. 671.El 672.El 673.It Ic negotiate 674Show or negotiate various communication parameters. 675Some controllers may 676not support setting or changing some of these values. 677For instance, the 678Adaptec 174x controllers do not support changing a device's sync rate or 679offset. 680The 681.Nm 682utility 683will not attempt to set the parameter if the controller indicates that it 684does not support setting the parameter. 685To find out what the controller 686supports, use the 687.Fl v 688flag. 689The meaning of the 690.Fl v 691flag for the 692.Ic negotiate 693command is described below. 694Also, some controller drivers do not support 695setting negotiation parameters, even if the underlying controller supports 696negotiation changes. 697Some controllers, such as the Advansys wide 698controllers, support enabling and disabling synchronous negotiation for 699a device, but do not support setting the synchronous negotiation rate. 700.Bl -tag -width 17n 701.It Fl a 702Attempt to make the negotiation settings take effect immediately by sending 703a Test Unit Ready command to the device. 704.It Fl c 705Show or set current negotiation settings. 706This is the default. 707.It Fl D Ar enable|disable 708Enable or disable disconnection. 709.It Fl M Ar mode 710Set ATA mode. 711.It Fl O Ar offset 712Set the command delay offset. 713.It Fl q 714Be quiet, do not print anything. 715This is generally useful when you want to 716set a parameter, but do not want any status information. 717.It Fl R Ar syncrate 718Change the synchronization rate for a device. 719The sync rate is a floating 720point value specified in MHz. 721So, for instance, 722.Sq 20.000 723is a legal value, as is 724.Sq 20 . 725.It Fl T Ar enable|disable 726Enable or disable tagged queueing for a device. 727.It Fl U 728Show or set user negotiation settings. 729The default is to show or set 730current negotiation settings. 731.It Fl v 732The verbose switch has special meaning for the 733.Ic negotiate 734subcommand. 735It causes 736.Nm 737to print out the contents of a Path Inquiry (XPT_PATH_INQ) CCB sent to the 738controller driver. 739.It Fl W Ar bus_width 740Specify the bus width to negotiate with a device. 741The bus width is 742specified in bits. 743The only useful values to specify are 8, 16, and 32 744bits. 745The controller must support the bus width in question in order for 746the setting to take effect. 747.El 748.Pp 749In general, sync rate and offset settings will not take effect for a 750device until a command has been sent to the device. 751The 752.Fl a 753switch above will automatically send a Test Unit Ready to the device so 754negotiation parameters will take effect. 755.It Ic format 756Issue the 757.Tn SCSI 758FORMAT UNIT command to the named device. 759.Pp 760.Em WARNING! WARNING! WARNING! 761.Pp 762Low level formatting a disk will destroy ALL data on the disk. 763Use 764extreme caution when issuing this command. 765Many users low-level format 766disks that do not really need to be low-level formatted. 767There are 768relatively few scenarios that call for low-level formatting a disk. 769One reason for 770low-level formatting a disk is to initialize the disk after changing 771its physical sector size. 772Another reason for low-level formatting a disk 773is to revive the disk if you are getting "medium format corrupted" errors 774from the disk in response to read and write requests. 775.Pp 776Some disks take longer than others to format. 777Users should specify a 778timeout long enough to allow the format to complete. 779The default format 780timeout is 3 hours, which should be long enough for most disks. 781Some hard 782disks will complete a format operation in a very short period of time 783(on the order of 5 minutes or less). 784This is often because the drive 785does not really support the FORMAT UNIT command -- it just accepts the 786command, waits a few minutes and then returns it. 787.Pp 788The 789.Sq format 790subcommand takes several arguments that modify its default behavior. 791The 792.Fl q 793and 794.Fl y 795arguments can be useful for scripts. 796.Pp 797.Bl -tag -width 6n 798.It Fl q 799Be quiet, do not print any status messages. 800This option will not disable 801the questions, however. 802To disable questions, use the 803.Fl y 804argument, below. 805.It Fl r 806Run in 807.Dq report only 808mode. 809This will report status on a format that is already running on the drive. 810.It Fl w 811Issue a non-immediate format command. 812By default, 813.Nm 814issues the FORMAT UNIT command with the immediate bit set. 815This tells the 816device to immediately return the format command, before the format has 817actually completed. 818Then, 819.Nm 820gathers 821.Tn SCSI 822sense information from the device every second to determine how far along 823in the format process it is. 824If the 825.Fl w 826argument is specified, 827.Nm 828will issue a non-immediate format command, and will be unable to print any 829information to let the user know what percentage of the disk has been 830formatted. 831.It Fl y 832Do not ask any questions. 833By default, 834.Nm 835will ask the user if he/she really wants to format the disk in question, 836and also if the default format command timeout is acceptable. 837The user 838will not be asked about the timeout if a timeout is specified on the 839command line. 840.El 841.It Ic idle 842Put ATA device into IDLE state. Optional parameter specifies automatic 843idle timer value in seconds. 844.It Ic standby 845Put ATA device into STANDBY state. Optional parameter specifies automatic 846standby timer value in seconds. 847.It Ic sleep 848Put ATA device into SLEEP state. Note that the only way get device out of 849this state may be reset. 850.It Ic help 851Print out verbose usage information. 852.El 853.Sh ENVIRONMENT 854The 855.Ev SCSI_MODES 856variable allows the user to specify an alternate mode page format file. 857.Pp 858The 859.Ev EDITOR 860variable determines which text editor 861.Nm 862starts when editing mode pages. 863.Sh FILES 864.Bl -tag -width /usr/share/misc/scsi_modes -compact 865.It Pa /usr/share/misc/scsi_modes 866is the SCSI mode format database. 867.It Pa /dev/xpt0 868is the transport layer device. 869.It Pa /dev/pass* 870are the CAM application passthrough devices. 871.El 872.Sh EXAMPLES 873.Dl camcontrol eject -n cd -u 1 -v 874.Pp 875Eject the CD from cd1, and print SCSI sense information if the command 876fails. 877.Pp 878.Dl camcontrol tur da0 879.Pp 880Send the SCSI test unit ready command to da0. 881The 882.Nm 883utility will report whether the disk is ready, but will not display sense 884information if the command fails since the 885.Fl v 886switch was not specified. 887.Pp 888.Bd -literal -offset indent 889camcontrol tur da1 -E -C 4 -t 50 -v 890.Ed 891.Pp 892Send a test unit ready command to da1. 893Enable kernel error recovery. 894Specify a retry count of 4, and a timeout of 50 seconds. 895Enable sense 896printing (with the 897.Fl v 898flag) if the command fails. 899Since error recovery is turned on, the 900disk will be spun up if it is not currently spinning. 901The 902.Nm 903utility will report whether the disk is ready. 904.Bd -literal -offset indent 905camcontrol cmd -n cd -u 1 -v -c "3C 00 00 00 00 00 00 00 0e 00" \e 906 -i 0xe "s1 i3 i1 i1 i1 i1 i1 i1 i1 i1 i1 i1" 907.Ed 908.Pp 909Issue a READ BUFFER command (0x3C) to cd1. 910Display the buffer size of cd1, 911and display the first 10 bytes from the cache on cd1. 912Display SCSI sense 913information if the command fails. 914.Pp 915.Bd -literal -offset indent 916camcontrol cmd -n cd -u 1 -v -c "3B 00 00 00 00 00 00 00 0e 00" \e 917 -o 14 "00 00 00 00 1 2 3 4 5 6 v v v v" 7 8 9 8 918.Ed 919.Pp 920Issue a WRITE BUFFER (0x3B) command to cd1. 921Write out 10 bytes of data, 922not including the (reserved) 4 byte header. 923Print out sense information if 924the command fails. 925Be very careful with this command, improper use may 926cause data corruption. 927.Pp 928.Bd -literal -offset indent 929camcontrol modepage da3 -m 1 -e -P 3 930.Ed 931.Pp 932Edit mode page 1 (the Read-Write Error Recover page) for da3, and save the 933settings on the drive. 934Mode page 1 contains a disk drive's auto read and 935write reallocation settings, among other things. 936.Pp 937.Dl camcontrol rescan all 938.Pp 939Rescan all SCSI busses in the system for devices that have been added, 940removed or changed. 941.Pp 942.Dl camcontrol rescan 0 943.Pp 944Rescan SCSI bus 0 for devices that have been added, removed or changed. 945.Pp 946.Dl camcontrol rescan 0:1:0 947.Pp 948Rescan SCSI bus 0, target 1, lun 0 to see if it has been added, removed, or 949changed. 950.Pp 951.Dl camcontrol tags da5 -N 24 952.Pp 953Set the number of concurrent transactions for da5 to 24. 954.Pp 955.Bd -literal -offset indent 956camcontrol negotiate -n da -u 4 -T disable 957.Ed 958.Pp 959Disable tagged queueing for da4. 960.Pp 961.Bd -literal -offset indent 962camcontrol negotiate -n da -u 3 -R 20.000 -O 15 -a 963.Ed 964.Pp 965Negotiate a sync rate of 20MHz and an offset of 15 with da3. 966Then send a 967Test Unit Ready command to make the settings take effect. 968.Sh SEE ALSO 969.Xr cam 3 , 970.Xr cam_cdbparse 3 , 971.Xr cam 4 , 972.Xr pass 4 , 973.Xr xpt 4 974.Sh HISTORY 975The 976.Nm 977utility first appeared in 978.Fx 3.0 . 979.Pp 980The mode page editing code and arbitrary SCSI command code are based upon 981code in the old 982.Xr scsi 8 983utility and 984.Xr scsi 3 985library, written by Julian Elischer and Peter Dufault. 986The 987.Xr scsi 8 988program first appeared in 989.Bx 386 0.1.2.4 , 990and first appeared in 991.Fx 992in 993.Fx 2.0.5 . 994.Sh AUTHORS 995.An Kenneth Merry Aq ken@FreeBSD.org 996.Sh BUGS 997The code that parses the generic command line arguments does not know that 998some of the subcommands take multiple arguments. 999So if, for instance, you 1000tried something like this: 1001.Bd -literal -offset indent 1002camcontrol cmd -n da -u 1 -c "00 00 00 00 00 v" 0x00 -v 1003.Ed 1004.Pp 1005The sense information from the test unit ready command would not get 1006printed out, since the first 1007.Xr getopt 3 1008call in 1009.Nm 1010bails out when it sees the second argument to 1011.Fl c 1012(0x00), 1013above. 1014Fixing this behavior would take some gross code, or changes to the 1015.Xr getopt 3 1016interface. 1017The best way to circumvent this problem is to always make sure 1018to specify generic 1019.Nm 1020arguments before any command-specific arguments. 1021