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