[SCSI] Small cleanups for scsi_host.h

Small cleanups in scsi_host.h. Few #defines make me wonder if their
description is still up to date..?

Signed-off-by: Pavel Machek <pavel@suse.cz>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>

authored by Pavel Machek and committed by James Bottomley d850bd34 8144f213

+25 -19
+25 -19
include/scsi/scsi_host.h
··· 280 280 * If the host wants to be called before the scan starts, but 281 281 * after the midlayer has set up ready for the scan, it can fill 282 282 * in this function. 283 + * 284 + * Status: OPTIONAL 283 285 */ 284 286 void (* scan_start)(struct Scsi_Host *); 285 287 286 288 /* 287 - * fill in this function to allow the queue depth of this host 288 - * to be changeable (on a per device basis). returns either 289 + * Fill in this function to allow the queue depth of this host 290 + * to be changeable (on a per device basis). Returns either 289 291 * the current queue depth setting (may be different from what 290 292 * was passed in) or an error. An error should only be 291 293 * returned if the requested depth is legal but the driver was 292 294 * unable to set it. If the requested depth is illegal, the 293 295 * driver should set and return the closest legal queue depth. 294 296 * 297 + * Status: OPTIONAL 295 298 */ 296 299 int (* change_queue_depth)(struct scsi_device *, int); 297 300 298 301 /* 299 - * fill in this function to allow the changing of tag types 302 + * Fill in this function to allow the changing of tag types 300 303 * (this also allows the enabling/disabling of tag command 301 304 * queueing). An error should only be returned if something 302 305 * went wrong in the driver while trying to set the tag type. 303 306 * If the driver doesn't support the requested tag type, then 304 307 * it should set the closest type it does support without 305 308 * returning an error. Returns the actual tag type set. 309 + * 310 + * Status: OPTIONAL 306 311 */ 307 312 int (* change_queue_type)(struct scsi_device *, int); 308 313 309 314 /* 310 - * This function determines the bios parameters for a given 315 + * This function determines the BIOS parameters for a given 311 316 * harddisk. These tend to be numbers that are made up by 312 317 * the host adapter. Parameters: 313 318 * size, device, list (heads, sectors, cylinders) 314 319 * 315 - * Status: OPTIONAL */ 320 + * Status: OPTIONAL 321 + */ 316 322 int (* bios_param)(struct scsi_device *, struct block_device *, 317 323 sector_t, int []); 318 324 ··· 357 351 358 352 /* 359 353 * This determines if we will use a non-interrupt driven 360 - * or an interrupt driven scheme, It is set to the maximum number 354 + * or an interrupt driven scheme. It is set to the maximum number 361 355 * of simultaneous commands a given host adapter will accept. 362 356 */ 363 357 int can_queue; ··· 378 372 unsigned short sg_tablesize; 379 373 380 374 /* 381 - * If the host adapter has limitations beside segment count 375 + * Set this if the host adapter has limitations beside segment count. 382 376 */ 383 377 unsigned short max_sectors; 384 378 385 379 /* 386 - * dma scatter gather segment boundary limit. a segment crossing this 380 + * DMA scatter gather segment boundary limit. A segment crossing this 387 381 * boundary will be split in two. 388 382 */ 389 383 unsigned long dma_boundary; ··· 392 386 * This specifies "machine infinity" for host templates which don't 393 387 * limit the transfer size. Note this limit represents an absolute 394 388 * maximum, and may be over the transfer limits allowed for 395 - * individual devices (e.g. 256 for SCSI-1) 389 + * individual devices (e.g. 256 for SCSI-1). 396 390 */ 397 391 #define SCSI_DEFAULT_MAX_SECTORS 1024 398 392 ··· 419 413 unsigned supported_mode:2; 420 414 421 415 /* 422 - * true if this host adapter uses unchecked DMA onto an ISA bus. 416 + * True if this host adapter uses unchecked DMA onto an ISA bus. 423 417 */ 424 418 unsigned unchecked_isa_dma:1; 425 419 426 420 /* 427 - * true if this host adapter can make good use of clustering. 421 + * True if this host adapter can make good use of clustering. 428 422 * I originally thought that if the tablesize was large that it 429 423 * was a waste of CPU cycles to prepare a cluster list, but 430 424 * it works out that the Buslogic is faster if you use a smaller ··· 434 428 unsigned use_clustering:1; 435 429 436 430 /* 437 - * True for emulated SCSI host adapters (e.g. ATAPI) 431 + * True for emulated SCSI host adapters (e.g. ATAPI). 438 432 */ 439 433 unsigned emulated:1; 440 434 ··· 444 438 unsigned skip_settle_delay:1; 445 439 446 440 /* 447 - * ordered write support 441 + * True if we are using ordered write support. 448 442 */ 449 443 unsigned ordered_tag:1; 450 444 451 445 /* 452 - * Countdown for host blocking with no commands outstanding 446 + * Countdown for host blocking with no commands outstanding. 453 447 */ 454 448 unsigned int max_host_blocked; 455 449 ··· 528 522 struct scsi_transport_template *transportt; 529 523 530 524 /* 531 - * area to keep a shared tag map (if needed, will be 532 - * NULL if not) 525 + * Area to keep a shared tag map (if needed, will be 526 + * NULL if not). 533 527 */ 534 528 struct blk_queue_tag *bqt; 535 529 ··· 602 596 /* 603 597 * Host uses correct SCSI ordering not PC ordering. The bit is 604 598 * set for the minority of drivers whose authors actually read 605 - * the spec ;) 599 + * the spec ;). 606 600 */ 607 601 unsigned reverse_ordering:1; 608 602 609 603 /* 610 - * ordered write support 604 + * Ordered write support 611 605 */ 612 606 unsigned ordered_tag:1; 613 607 614 - /* task mgmt function in progress */ 608 + /* Task mgmt function in progress */ 615 609 unsigned tmf_in_progress:1; 616 610 617 611 /* Asynchronous scan in progress */