Template:Infobox hard drive/doc

This is a documentation subpage for Template:Infobox hard drive. It contains usage information, categories and other content that is not part of the original template page.

This infobox is designed for hard drive model articles. It shows various hard drive parameters, such as speed, capacity and per-platter capacity.

Examples

This example infobox is generated using the following code:

{{infobox hard drive
|image1 = TOSHIBA HDWR480 top lid and label view.jpg
|caption1 = Top lid of a HDWR480UZSVA.
|image2 = CrystalDiskInfo prinout - TOSHIBA HDWR480.png
|caption2 = CrystalDiskInfo printout of SMART attributes.
|audio1 = TOSHIBA HDWR480 spinup and spindown sounds.wav
|audio1_caption = Spinup and spindown sounds of a TOSHIBA HDWR480.
|platform = MG08ADA
|manufacturer = [[Toshiba]]
|family = [[Toshiba X300]]/[[Toshiba X300 Pro]]
|form_factor = 3.5"
|z-height = 26.1
|speed = 7,200
|capacity = 8
|capacity_unit = tb
|cache = 256
|cache_unit = mb
|af = 512e
|max_transfer = 248
|interface = SATA
|interface_version = SATA 3.3 (600 MB/s)
|command_set = ACS-3 Revision 5
|apm = Yes
|aam = No
|ncq = Yes
|gpl = Yes
|scterc = Read: Disabled<br>Write: Disabled
|statistics = Yes
|platters = 5
|heads = 10
|capacity_per_platter = 1.6
|capacity_per_platter_unit = tb
|recording_method = cmr
|mttf = 600,000 hours
|max_load_cycles = 300,000
|unrecoverable_error_rate = <math>1</math> in <math>10^{14}</math>
|kcc = R-R-T48-MG08ADA400N
|pcb = G0049A
|released = 2021
|predecessor = [[TOSHIBA HDWR180]]
|successor = [[TOSHIBA HDWR780]]
}}

For detailed usage information on each parameter, see the TemplateData.

Capacity discrepancy verification

This template verifies whether the following rules are true.

1. There cannot be more heads than double the platter count. (2 platters, 4 heads is legal, since $2\times 2=4$, but 2 platters, 6 heads is not legal, since $2\times 2\ne 6$.)
2. The total capacity equals the difference between (Platter capacity multiplied by (number of heads divided by 2)) and short-stroked capacity, adjusted for units.
   • This is summed up by this mathematical statement: $C=(P\times h/2)-S$, where C = given capacity, P = platter capacity, h = heads and S = short-stroked capacity.

If one or both of these rules are violated, the page is categorised into Category:Hard drive models with capacity, capacity per platter and short stroked capacity calculation errors, and an error is raised in the Capacity field warning that such a discrepancy was found. Please correct the following fields, preferably by consulting a source such as the RML527 HDD Platter Capacity Database, and check using preview that your edit clears the error.

• capacity and capacity_unit
• capacity_per_platter and capacity_per_platter_unit
• platters (if the problem is that there are too few platters for the number of heads)
• heads
• short_stroked_capacity and short_stroked_capacity_unit

TemplateData

Displays information on hard drive models.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Image 1	image1	File name for the first image on the infobox. Example TOSHIBA HDWJ110.jpg	File	suggested
Image caption 1	caption1	An image caption to accompany image 1. Also acts as alt text if not explicity provided. Example Top down view of the hard drive.	Content	suggested
Alt text 1	alt1	Alt text associated with image 1. Default {{{caption1}}}	String	optional
Image 2	image2	File name for the second image on the infobox. Example Toshiba HDWJ110 SMART printout.png	File	optional
Image caption 2	caption2	An image caption to accompany image 2. Also acts as alt text if not explicitly provided.	Content	optional
Alt text 2	alt2	Alt text associated with image 2. Default {{{caption2}}}	String	optional
Image 3	image3	File name for the third image on the infobox. Example Toshiba HDWJ110 SMART printout.png	File	optional
Image caption 3	caption3	An image caption to accompany image 3. Also acts as alt text if not explicitly provided.	String	optional
Alt text 3	alt3	Alt text associated with image 3. Default {{{caption3}}}	String	optional
Manufacturer	manufacturer	The company who manufactures or manufactured this hard drive model. Example [[Western Digital]]	Page name	required
Product family	family	The product family the hard drive model belongs to. Example [[Toshiba P300]]	Page name	suggested
Platform	platform	The platform name (such as a WD Marvell family). Example Diablo3s	String	optional
Form factor	form_factor	The form factor of the hard drive model, expressed in inches (as in, 3.5"). Suggested values 1.8" 2.5" 3.5" 5.25" Example 3.5"	String	required
z-height	z-height	The total z-height of the drive in millimetres. Most useful for 2.5"s, most 3.5"s are 26.1. Suggested values 7 9.5 12.5 15 20.2 26.1 Example 9.5	Number	suggested
Capacity	capacity	The advertised capacity of the hard drive model. Do not include units, as those go in a separate parameter. If the actual user capacity is different to the advertised one, that is reflected in the LBA parameter, not here (e.g. if the HDD model is marketed as 160 GB but its actual capacity is 164, write 160 here). Do not use binary capacities (such as 236 instead of 256). Example 500	Number	suggested
Capacity unit	capacity_unit	The two- or three- letter acronym for the capacity's unit. Case insensitive. Accepts all parameters that Template:Cache unit accepts. Suggested values mb gb tb Example gb	String	required
Rotation speed	speed	The speed that the hard drive platters rotate at. Suggested values 4,200 5,000 5,400 5,900 7,200 Example 5,400	Number	suggested
Cache	cache	The amount of cache RAM the hard drive contains. Suggested values 2,048 8,192 16,384 32 64 128 256 512 Example 64	Number	suggested
Cache unit	cache_unit	The two- or three- letter acronym for the cache capacity's unit. Case insensitive. Accepts all parameters that Template:Cache unit accepts. Suggested values kib mib Example mb	String	suggested
Maximum sustained transfer rate	max_transfer	The maximum specified transfer rate, in MB/s. Note that some datasheets specify this in Mbits for some reason; for those, provide an MB/s translation as well as the original. Example 180	Number	suggested
LBAs	lbas	The number of LBAs the hard drive has available. If left blank, this is automatically calculated using the IDEMA formula and the values of capacity, capacity_unit, and either logical_sector_size or af. It should not be necessary to explicitly set this parameter, except when the drive model does not conform to IDEMA formulae.	Number	optional
Logical C/H/S	chs	If the drive has a specific logical C/H/S, specify it here. Give the parameters in the order of cylinders, heads and sectors, separated by forward slashes. Example 1654/16/63	String	optional
User capacity	user_capacity	The amount of user capacity the hard drive has available, in bytes. If left blank, this is automatically calculated using the IDEMA formula and the values of logical_sector_size or af. It should not be necessary to explicitly set this parameter for most IDEMA formulae conforming drives; only use it when the drive model does not conform to IDEMA formulae.	Number	optional
Advanced Format status	af	Whether the hard drive supports Advanced Format, and if so, what type it supports (512e, or 4Kn). Setting this field will automatically specify the logical_sector_size and physical_sector_size fields to their correct values. Suggested values No 512e 4Kn Example No	String	suggested
Logical sector size	logical_sector_size	The size of each LBA in bytes. If left blank, this is automatically detected from the drive's Advanced Format support.	Number	optional
Physical sector size	physical_sector_size	The size of each physical sector in bytes. If left blank, this is automatically detected from the drive's Advanced Format support.	Number	optional
Interface	interface	The acronym for the interface in use (pata, sata, scsi, sas). Case insensitive. Suggested values sata pata scsi sas usb Example sata	String	suggested
Interface version	interface_version	The version of the interface in use, and its speed. Suggested values SATA 1.0 (150 MB/s) SATA 2.0 (300 MB/s) SATA 2.5 (300 MB/s) SATA 2.6 (300 MB/s) SATA 3.0 (600 MB/s) SATA 3.1 (600 MB/s) SATA 3.2 (600 MB/s) SATA 3.3 (600 MB/s) Example SATA 3.3 (600 MB/s)	String	suggested
Command set	command_set	The command set used for interfacing with the drive. Suggested values ATA/ATAPI 7 ATA8-ACS ACS-2 ACS-3 Revision 3b ACS-3 Revision 5 Example ACS-3 Revision 5	String	suggested
APM?	apm	Whether the hard drive supports Advanced Power Management (APM). Suggested values Yes No Example Yes	String	required
NCQ?	ncq	Whether the hard drive supports Native Command Queing (NCQ). Suggested values Yes No Example Yes	String	required
AAM?	aam	Whether the hard drive supports Automatic Acoustic Management (AAM). Suggested values Yes No Example No	String	suggested
GPL?	gpl	Whether the drive supports General Purpose Log. Suggested values Yes No	String	suggested
TRIM?	trim	Whether the hard drive supports the TRIM command. Manually specifying "No" is only needed if the drive is SMR; leave blank otherwise. Suggested values Yes No Example Yes	String	optional
SIE?	sie	Whether the hard drive model supports Sanitize Instant Erase (SIE). Suggested values Yes No Default No Example Yes	String	optional
SED algorithm	sed	If supported, defines what algorithm the model uses for self-encryption. Specify "Unknown (supported)" if the drive does support self-encryption, but the algorithm used is not known. Leave blank if the drive does not support it at all. Default None Example AES-256	String	optional
SCTERC defaults	scterc	The default settings for SCTERC. Write "Not supported" if the drive does not support SCTERC at all. Suggested values Read: Disabled<br>Write: Disabled Not supported Example Read: Disabled<br>Write: Disabled	String	suggested
Device Statistics?	statistics	Whether the device supports Device Statistics. Suggested values Yes No Example Yes	String	required
Platter count	platters	Number of known platters in a hard drive model. Example 7	Number	suggested
Head count	heads	Number of heads in a hard drive model. Example 14	Number	suggested
Capacity per platter	capacity_per_platter	The amount of capacity stored on each platter. Example 1.43	Number	suggested
Capacity per platter unit	capacity_per_platter_unit	The two- or three- letter acronym for the capacity's unit. Case insensitive. Accepts all parameters that Template:Cache unit accepts, but this should not be used with binary units normally. Suggested values mb gb tb Example tb	String	suggested
Recording method	recording_method	The three, four or similar acronym for the recording method. Case insensitive. Suggested values cmr lmr smr hamr fc-mamr Example cmr	String	suggested
Mean time to failure	mttf	Mean time to failure published by the manufacturer. Do not use crowd-sourced information such as ST3000DM001s all failing at low hour numbers. Suggested values Not specified Example 600,000 hours	String	required
Maximum load/unload cycles	max_load_cycles	Maximum load/unload cycle count published. Example 600,000	Number	suggested
Unrecoverable error rate	unrecoverable_error_rate	Unrecoverable error rate specified by the manufacturer. Use math when possible. Suggested values <math>1</math> in <math>10^14</math> <math>1</math> in <math>10^15</math> Example <math>1</math> in <math>10^14</math> Auto value	Content	suggested
KCC/MSIP Authorization Number	kcc	The model's Authorization Number assigned by the KCC (Korean Communications Commission)/MSIP (Ministry for Science, ICT and Future Planning). Example R-R-T48-MG08ADA400N	String	suggested
KCC/MSIP Authorization Number wikitext	kcc_wikitext	Custom wikitext to use for the KCC/MSIP ID parameter. By default, the infobox places the ID given in kcc into a wikilink; use this to disable it if that causes problems or to specify if the drive does not have a KCC or MSIP Authorization Number at all..	Unbalanced wikitext	optional
PCB part number(s)	pcb	The part numbers of all known PCBs used by this drive. Example G0066A	String	suggested
Date released	released	The year (add more precision if desired/known) the hard drive model was released. Example 2012	Date	suggested
Date discontinued	discontinued	The year (add more precision if desired/known) the model was discontinued. Example 2017	Date	optional
Force categorisation	force_cat	Force automatic categorisation to be suppressed (-1) or always show (1). Leave blank or use any other value to automatically categorise only in mainspace. Suggested values -1 0 1 Example -1	Number	optional
Predecessor	predecessor	Wikilink or wikilinks to the model best described as the predecessor to the infobox subject. Example [[TOSHIBA MQ01ABD100]]	Unknown	optional
Successor	successor	Wikilink or wikilinks to the model best described as the successor to the infobox subject. Example [[TOSHIBA HDWL110]]	Unknown	optional