diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2005-10-25 01:44:30 -0400 |
---|---|---|
committer | Jeff Garzik <jgarzik@pobox.com> | 2005-10-25 01:44:30 -0400 |
commit | 6f0ef4fa57b9ba27d7b1c330bad041f1665501fe (patch) | |
tree | 1d700a0fe5f1065b1e60d09587111f66ef2b19eb /drivers/scsi/libata-core.c | |
parent | 057ace5e79da9ebf2aa82833cfea825533ac06fb (diff) |
[PATCH] libata kernel-doc fixes
Correct some function names in kernel-doc.
Add some kernel-doc descriptions.
Fix some typos.
Remove a few blank lines.
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jeff Garzik <jgarzik@pobox.com>
Diffstat (limited to 'drivers/scsi/libata-core.c')
-rw-r--r-- | drivers/scsi/libata-core.c | 36 |
1 files changed, 14 insertions, 22 deletions
diff --git a/drivers/scsi/libata-core.c b/drivers/scsi/libata-core.c index d55f12dacfcb..dcd3b5553cc8 100644 --- a/drivers/scsi/libata-core.c +++ b/drivers/scsi/libata-core.c | |||
@@ -87,7 +87,7 @@ MODULE_LICENSE("GPL"); | |||
87 | MODULE_VERSION(DRV_VERSION); | 87 | MODULE_VERSION(DRV_VERSION); |
88 | 88 | ||
89 | /** | 89 | /** |
90 | * ata_tf_load - send taskfile registers to host controller | 90 | * ata_tf_load_pio - send taskfile registers to host controller |
91 | * @ap: Port to which output is sent | 91 | * @ap: Port to which output is sent |
92 | * @tf: ATA taskfile register set | 92 | * @tf: ATA taskfile register set |
93 | * | 93 | * |
@@ -2701,13 +2701,13 @@ void ata_poll_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat) | |||
2701 | 2701 | ||
2702 | /** | 2702 | /** |
2703 | * ata_pio_poll - | 2703 | * ata_pio_poll - |
2704 | * @ap: | 2704 | * @ap: the target ata_port |
2705 | * | 2705 | * |
2706 | * LOCKING: | 2706 | * LOCKING: |
2707 | * None. (executing in kernel thread context) | 2707 | * None. (executing in kernel thread context) |
2708 | * | 2708 | * |
2709 | * RETURNS: | 2709 | * RETURNS: |
2710 | * | 2710 | * timeout value to use |
2711 | */ | 2711 | */ |
2712 | 2712 | ||
2713 | static unsigned long ata_pio_poll(struct ata_port *ap) | 2713 | static unsigned long ata_pio_poll(struct ata_port *ap) |
@@ -2748,8 +2748,8 @@ static unsigned long ata_pio_poll(struct ata_port *ap) | |||
2748 | } | 2748 | } |
2749 | 2749 | ||
2750 | /** | 2750 | /** |
2751 | * ata_pio_complete - | 2751 | * ata_pio_complete - check if drive is busy or idle |
2752 | * @ap: | 2752 | * @ap: the target ata_port |
2753 | * | 2753 | * |
2754 | * LOCKING: | 2754 | * LOCKING: |
2755 | * None. (executing in kernel thread context) | 2755 | * None. (executing in kernel thread context) |
@@ -2801,7 +2801,7 @@ static int ata_pio_complete (struct ata_port *ap) | |||
2801 | 2801 | ||
2802 | 2802 | ||
2803 | /** | 2803 | /** |
2804 | * swap_buf_le16 - | 2804 | * swap_buf_le16 - swap halves of 16-words in place |
2805 | * @buf: Buffer to swap | 2805 | * @buf: Buffer to swap |
2806 | * @buf_words: Number of 16-bit words in buffer. | 2806 | * @buf_words: Number of 16-bit words in buffer. |
2807 | * | 2807 | * |
@@ -2810,6 +2810,7 @@ static int ata_pio_complete (struct ata_port *ap) | |||
2810 | * vice-versa. | 2810 | * vice-versa. |
2811 | * | 2811 | * |
2812 | * LOCKING: | 2812 | * LOCKING: |
2813 | * Inherited from caller. | ||
2813 | */ | 2814 | */ |
2814 | void swap_buf_le16(u16 *buf, unsigned int buf_words) | 2815 | void swap_buf_le16(u16 *buf, unsigned int buf_words) |
2815 | { | 2816 | { |
@@ -2832,7 +2833,6 @@ void swap_buf_le16(u16 *buf, unsigned int buf_words) | |||
2832 | * | 2833 | * |
2833 | * LOCKING: | 2834 | * LOCKING: |
2834 | * Inherited from caller. | 2835 | * Inherited from caller. |
2835 | * | ||
2836 | */ | 2836 | */ |
2837 | 2837 | ||
2838 | static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf, | 2838 | static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf, |
@@ -2878,7 +2878,6 @@ static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf, | |||
2878 | * | 2878 | * |
2879 | * LOCKING: | 2879 | * LOCKING: |
2880 | * Inherited from caller. | 2880 | * Inherited from caller. |
2881 | * | ||
2882 | */ | 2881 | */ |
2883 | 2882 | ||
2884 | static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf, | 2883 | static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf, |
@@ -2918,7 +2917,6 @@ static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf, | |||
2918 | * | 2917 | * |
2919 | * LOCKING: | 2918 | * LOCKING: |
2920 | * Inherited from caller. | 2919 | * Inherited from caller. |
2921 | * | ||
2922 | */ | 2920 | */ |
2923 | 2921 | ||
2924 | static void ata_data_xfer(struct ata_port *ap, unsigned char *buf, | 2922 | static void ata_data_xfer(struct ata_port *ap, unsigned char *buf, |
@@ -3071,7 +3069,6 @@ next_sg: | |||
3071 | * | 3069 | * |
3072 | * LOCKING: | 3070 | * LOCKING: |
3073 | * Inherited from caller. | 3071 | * Inherited from caller. |
3074 | * | ||
3075 | */ | 3072 | */ |
3076 | 3073 | ||
3077 | static void atapi_pio_bytes(struct ata_queued_cmd *qc) | 3074 | static void atapi_pio_bytes(struct ata_queued_cmd *qc) |
@@ -3107,8 +3104,8 @@ err_out: | |||
3107 | } | 3104 | } |
3108 | 3105 | ||
3109 | /** | 3106 | /** |
3110 | * ata_pio_sector - | 3107 | * ata_pio_block - start PIO on a block |
3111 | * @ap: | 3108 | * @ap: the target ata_port |
3112 | * | 3109 | * |
3113 | * LOCKING: | 3110 | * LOCKING: |
3114 | * None. (executing in kernel thread context) | 3111 | * None. (executing in kernel thread context) |
@@ -3120,7 +3117,7 @@ static void ata_pio_block(struct ata_port *ap) | |||
3120 | u8 status; | 3117 | u8 status; |
3121 | 3118 | ||
3122 | /* | 3119 | /* |
3123 | * This is purely hueristic. This is a fast path. | 3120 | * This is purely heuristic. This is a fast path. |
3124 | * Sometimes when we enter, BSY will be cleared in | 3121 | * Sometimes when we enter, BSY will be cleared in |
3125 | * a chk-status or two. If not, the drive is probably seeking | 3122 | * a chk-status or two. If not, the drive is probably seeking |
3126 | * or something. Snooze for a couple msecs, then | 3123 | * or something. Snooze for a couple msecs, then |
@@ -3440,7 +3437,6 @@ static void __ata_qc_complete(struct ata_queued_cmd *qc) | |||
3440 | * | 3437 | * |
3441 | * LOCKING: | 3438 | * LOCKING: |
3442 | * spin_lock_irqsave(host_set lock) | 3439 | * spin_lock_irqsave(host_set lock) |
3443 | * | ||
3444 | */ | 3440 | */ |
3445 | void ata_qc_free(struct ata_queued_cmd *qc) | 3441 | void ata_qc_free(struct ata_queued_cmd *qc) |
3446 | { | 3442 | { |
@@ -3460,7 +3456,6 @@ void ata_qc_free(struct ata_queued_cmd *qc) | |||
3460 | * | 3456 | * |
3461 | * LOCKING: | 3457 | * LOCKING: |
3462 | * spin_lock_irqsave(host_set lock) | 3458 | * spin_lock_irqsave(host_set lock) |
3463 | * | ||
3464 | */ | 3459 | */ |
3465 | 3460 | ||
3466 | void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat) | 3461 | void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat) |
@@ -3954,7 +3949,6 @@ idle_irq: | |||
3954 | * | 3949 | * |
3955 | * RETURNS: | 3950 | * RETURNS: |
3956 | * IRQ_NONE or IRQ_HANDLED. | 3951 | * IRQ_NONE or IRQ_HANDLED. |
3957 | * | ||
3958 | */ | 3952 | */ |
3959 | 3953 | ||
3960 | irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs) | 3954 | irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs) |
@@ -4066,6 +4060,7 @@ err_out: | |||
4066 | * May be used as the port_start() entry in ata_port_operations. | 4060 | * May be used as the port_start() entry in ata_port_operations. |
4067 | * | 4061 | * |
4068 | * LOCKING: | 4062 | * LOCKING: |
4063 | * Inherited from caller. | ||
4069 | */ | 4064 | */ |
4070 | 4065 | ||
4071 | int ata_port_start (struct ata_port *ap) | 4066 | int ata_port_start (struct ata_port *ap) |
@@ -4091,6 +4086,7 @@ int ata_port_start (struct ata_port *ap) | |||
4091 | * May be used as the port_stop() entry in ata_port_operations. | 4086 | * May be used as the port_stop() entry in ata_port_operations. |
4092 | * | 4087 | * |
4093 | * LOCKING: | 4088 | * LOCKING: |
4089 | * Inherited from caller. | ||
4094 | */ | 4090 | */ |
4095 | 4091 | ||
4096 | void ata_port_stop (struct ata_port *ap) | 4092 | void ata_port_stop (struct ata_port *ap) |
@@ -4113,6 +4109,7 @@ void ata_host_stop (struct ata_host_set *host_set) | |||
4113 | * @do_unregister: 1 if we fully unregister, 0 to just stop the port | 4109 | * @do_unregister: 1 if we fully unregister, 0 to just stop the port |
4114 | * | 4110 | * |
4115 | * LOCKING: | 4111 | * LOCKING: |
4112 | * Inherited from caller. | ||
4116 | */ | 4113 | */ |
4117 | 4114 | ||
4118 | static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister) | 4115 | static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister) |
@@ -4140,7 +4137,6 @@ static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister) | |||
4140 | * | 4137 | * |
4141 | * LOCKING: | 4138 | * LOCKING: |
4142 | * Inherited from caller. | 4139 | * Inherited from caller. |
4143 | * | ||
4144 | */ | 4140 | */ |
4145 | 4141 | ||
4146 | static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host, | 4142 | static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host, |
@@ -4201,7 +4197,6 @@ static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host, | |||
4201 | * | 4197 | * |
4202 | * RETURNS: | 4198 | * RETURNS: |
4203 | * New ata_port on success, for NULL on error. | 4199 | * New ata_port on success, for NULL on error. |
4204 | * | ||
4205 | */ | 4200 | */ |
4206 | 4201 | ||
4207 | static struct ata_port * ata_host_add(const struct ata_probe_ent *ent, | 4202 | static struct ata_port * ata_host_add(const struct ata_probe_ent *ent, |
@@ -4249,7 +4244,6 @@ err_out: | |||
4249 | * | 4244 | * |
4250 | * RETURNS: | 4245 | * RETURNS: |
4251 | * Number of ports registered. Zero on error (no ports registered). | 4246 | * Number of ports registered. Zero on error (no ports registered). |
4252 | * | ||
4253 | */ | 4247 | */ |
4254 | 4248 | ||
4255 | int ata_device_add(const struct ata_probe_ent *ent) | 4249 | int ata_device_add(const struct ata_probe_ent *ent) |
@@ -4381,7 +4375,6 @@ err_out: | |||
4381 | * Inherited from calling layer (may sleep). | 4375 | * Inherited from calling layer (may sleep). |
4382 | */ | 4376 | */ |
4383 | 4377 | ||
4384 | |||
4385 | void ata_host_set_remove(struct ata_host_set *host_set) | 4378 | void ata_host_set_remove(struct ata_host_set *host_set) |
4386 | { | 4379 | { |
4387 | struct ata_port *ap; | 4380 | struct ata_port *ap; |
@@ -4614,7 +4607,6 @@ static struct ata_probe_ent *ata_pci_init_legacy_port(struct pci_dev *pdev, stru | |||
4614 | * | 4607 | * |
4615 | * RETURNS: | 4608 | * RETURNS: |
4616 | * Zero on success, negative on errno-based value on error. | 4609 | * Zero on success, negative on errno-based value on error. |
4617 | * | ||
4618 | */ | 4610 | */ |
4619 | 4611 | ||
4620 | int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, | 4612 | int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info, |
@@ -4762,7 +4754,7 @@ err_out: | |||
4762 | * @pdev: PCI device that was removed | 4754 | * @pdev: PCI device that was removed |
4763 | * | 4755 | * |
4764 | * PCI layer indicates to libata via this hook that | 4756 | * PCI layer indicates to libata via this hook that |
4765 | * hot-unplug or module unload event has occured. | 4757 | * hot-unplug or module unload event has occurred. |
4766 | * Handle this by unregistering all objects associated | 4758 | * Handle this by unregistering all objects associated |
4767 | * with this PCI device. Free those objects. Then finally | 4759 | * with this PCI device. Free those objects. Then finally |
4768 | * release PCI resources and disable device. | 4760 | * release PCI resources and disable device. |