Skip to content

Instantly share code, notes, and snippets.

@DanielKeep

DanielKeep/HIT_HMD2043.txt

Created April 26, 2012 03:35
Show Gist options
  • Save DanielKeep/2495578 to your computer and use it in GitHub Desktop.
Save DanielKeep/2495578 to your computer and use it in GitHub Desktop.
Download ZIP
Harold Innovation Technologies - HMD2043 and HMU1440 spec sheets
Raw
HIT_HMD2043.txt
HIT_HMD2043
__ __
|| ||
||==|| I T
_|| ||_
Harold Innovation Technologies
"If it ain't a HIT, it's a piece of..."
DCPU-16 Hardware Info:
Name: HMD2043 - Harold Media Drive
ID: 0x74fa4cae, version: 0x07c2
Manufacturer: 0x21544948 (HAROLD_IT)
Document version: 1.1
Change history:
1.1: Added command for setting interrupt message. Fixed manufacturer id
which was erroneously word-swapped.
1.0: Initial release.
Description:
The HMD2043 is the latest effort on the part of Harold Innovation
Technologies to futurise the computing landscape of tomorrow; today!
It is a high-quality disk drive made from the finest materials known to
man. It supports a vast panopoly of disk formats:
* HMU1440 - 1.44 MB 3.5" Harold Media Unit.
Because of its amazing all-American construction, it will also support disks
manufactured by other, inferior "technology" companies; YOU KNOW WHO YOU
ARE! The drive incorporates unique "quality sensing" technology to identify
low-quality disks, allowing the system to warn the user. But, I'm a big
enough man to stoop to your level and...
Waitaminute; I've just had an idea for a motorised stooping machine;
Angela, get the engineers in here and turn this damn recorde
-- Harold Lam, Founder and Chief Innovationist.
Interrupt behaviour:
The HMD2043 supports a number of HWI commands based on the value of the A
register:
0x0000: QUERY_MEDIA_PRESENT
If a supported disk is present in the drive, this sets the B
register to 1. Otherwise, it sets the B register to 0.
Media should be tested with the 0xFFFF command before use.
0x0001: QUERY_MEDIA_PARAMETERS
Reads out the physical properties of the media. They are placed
into registers as follows:
B = Number of words per sector.
C = Number of sectors.
X = 1 if media is write-locked, 0 otherwise.
0x0002: QUERY_DEVICE_FLAGS
Returns the internal device flags in the B register. The meaning
of this field is defined in the UPDATE_DEVICE_FLAGS command.
0x0003: UPDATE_DEVICE_FLAGS
Sets the internal device flags to the value of the B register. The
available bit flags are, by bit number:
0: NON_BLOCKING - if set, all slow operations will be performed in
"non-blocking" mode; that is, the hardware command will return
control to the DCPU immediately and an interrupt will be issued
upon completion.
Note that other commands issued during a non-blocking operation
will silently fail.
Until the interrupt is raised, the device will NOT consider the
non-blocking operation "complete".
Before issuing a non-blocking command, be sure to set an
appropriate interrupt message with SET_INTERRUPT_MESSAGE.
1: MEDIA_STATUS_INTERRUPT - if set, the device will raise an
interrupt when the media status changes: new media is inserted
or current media ejected.
Before enabling media status interrupts, be sure to set an
appropriate interrupt message with SET_INTERRUPT_MESSAGE.
The default value is all bits set to zero.
0x0004: QUERY_INTERRUPT_TYPE
The device will indicate the type of interrupt that it last raised
by placing one of the following values into the B register:
0x0000: NONE - No interrupts have been raised yet.
0x0001: MEDIA_STATUS - Media status changed.
0x0002: READ_COMPLETE - Read operation completed.
0x0003: WRITE_COMPLETE - Write operation completed.
The value of the A register will be changed to the error status of
the event in question, not the error status of the
QUERY_INTERRUPT_TYPE command itself.
0x0005: SET_INTERRUPT_MESSAGE
Specifies the message the device should use for software interrupts.
Takes one parameter:
B = Interrupt number to use when interrupting the DCPU.
If the device raises an interrupt before the message is set, it will
default to using 0xFFFF.
0x0010: READ_SECTORS
Reads a contiguous range of sectors into memory. The parameters
are:
B = Initial sector to read.
C = Number of sectors to read.
X = Start of in-memory buffer to read into.
The length of time this command will take depends on the state of
the drive and the physical parameters of the media in use.
This operation may be performed in non-blocking mode.
0x0011: WRITE_SECTORS
Writes a contiguous range of sectors to disk. The parameters are:
B = Initial sector to write.
C = Number of sectors to write.
X = Start of in-memory buffer to read from.
The length of time this command will take depends on the state of
the drive and the physical parameters of the media in use.
This operation may be performed in non-blocking mode.
0xFFFF: QUERY_MEDIA_QUALITY
Determines the quality of the media inserted into the drive. It
places this value into the B register. It has the following values:
0x7FFF: Authentic HIT media.
0xFFFF: Media from other companies.
All commands replace the contents of the A register with a flag indicating
whether the command succeeded or failed. The following result codes are
defined:
0x0000: ERROR_NONE - The operation either completed or (for non-blocking
operations) begun successfully.
0x0001: ERROR_NO_MEDIA - Operation requires media to be present. In long
operations, this can occur if the media is ejected during the
operation.
0x0002: ERROR_INVALID_SECTOR - Attempted to read or write to an invalid
sector number.
0x0003: ERROR_PENDING - Attempted to perform a non-blocking operation
whilst a conflicting operation was already in progress: the most
recent operation has been aborted.
Performance:
Full-stroke: 200 ms
Spindle speed: 300 RPM, 5 Hz using Constant Angular Velocity
Maximum data transfer speed: 768 kbit/s, 48 kw/s
Head position on media insertion: innermost track
Head mode: full duplex [1]
Time to seek to sector =
floor( abs(target sector - current sector)
/ (disk sectors per track) )
* full stroke time / (disk tracks - 1)
Time to read/write a sector =
1 / (spindle speed * disk sectors per track)
Example times:
1.44 MB 3.5" Disk:
Time to seek to adjacent track = 2.5 ms
Time to read/write a sector = 11 ms
Time to read/write entire disk = 16 s
[1] The head is capable of reading/writing both sides of the disc at the
same time.
EOF
HIT_HMU1440
__ __
|| ||
||==|| I T
_|| ||_
Harold Innovation Technologies
"If it ain't a HIT, it's a piece of..."
Media Info:
Name: HMU1440 - 1.44 MB 3.5" Harold Media Unit
Document version: 1.1
Description:
The HMU1440 is the latest effort on the part of Harold Innovation
Technologies to futurise the computing landscape of tomorrow; today!
It is a high-density, double-sided magnetic storage device. That's right,
it uses MAGNETS to store DATA. Isn't technology amazing?
It packs a whopping 1,440 512-word sectors into 80 beautifully delineated
tracks for a total stuff-icity of 1,474,560 octets.
It also comes complete with a precision Write Lock slide-switch to protect
your many and varied files and a super high-quality Label, pre-lined for
your convenience and compatible with most writing implements on the market
today! It is also available in a wide variety of colors including Blue and
White, but NOT Red.
This disc is of such high quality of construction and design that it can
only be reliably WRITTEN to by Harold Innovation Technologies' HMD2043
Harold Media Drive. However, this disc is of such high quality of
construction and design that it can be reliably READ from by even the most
basic and technologically backward of disk drives.
So enjoy, and may this happy little disk provide you years of faithful
service before inexplicably failing, but not so fast that you cannot buy a
new disk and save almost all of your data.
-- Harold Lam, Founder and Chief Innovationist.
Specification:
Data surfaces: 2
Tracks: 80
Sectors per track: 18
Total sectors: 1440
Note: sectors are spread across both data surfaces; specifically, even bits
of a sector are stored on the "top" data surface, odd bits on the "bottom"
data surface. This doubles effective read/write speed.
EOF
Author's Note:
A. I wanted a floppy spec.
B. I wanted a little bit of Cave Johnson.
I tried to write Harold Lam as an antagonistic, blindly patriotic man who
is none the less a savvy businessman who has managed to build up an IT
empire despite his at-times dogmatic approach.
Plus, I figured it could be a source of fun in the game's backstory to have
at least two, at-odds technology companies (all gone and turned to dust by
now) taking pot shots at one another through the eloquent medium of spec
sheets. Or at least *one* technology company at-odds with and taking pot-
shots at *everyone else*.
In response to this, the engineers do their best to subtly mock him. Like
the result of command 0xFFFF: they don't specify whether it's signed or
not. The command is only there at all because Lam decreed it thus.
Also, originally I mistakenly thought that Nya Elektriska was Russian. I
have no excuses for why; that's just what popped into my head when I first
saw the name. I'd like to apologise to everyone for the mistake. I've
since revised Lam's introduction to the HMD2043.
As for implementation, I've tried to include enough explicit timing
information to make working out how many cycles to "block" for relatively
easy. The only possibly tricky bit is the non-blocking mode. For that to
be efficiently implemented, the emulator will need some kind of event queue
for keeping track of upcoming events.
Although it would be more realistic to have the data trickle into memory
during a non-blocking operation, I think we can probably get away with just
doing it all-at-once at the end of the wait time for now.
Incidentally, the design of the disks *more or less* matches that of the
real 1.44 MB 3.5" disks. In order to make them more DCPU-16 friendly, I
specified that the sectors on both sides of the disc are really one, giving
us sectors that are twice the size (by number of bits), but with the same
overall physical configuration and capacity.
@jonpovey
Copy link

Cool, glad to help!

@rmmh
Copy link

rmmh commented Apr 26, 2012

" If interrupts are disabled, the device will wait until they are re-enabled again and then raise the interrupt. Until the interrupt is raised, the device will NOT consider the non- blocking operation "complete"."

With the queued interrupts (IAQ) in 1.5, this could probably be removed.

@DanielKeep
Copy link
Author

rmmh: You're right. I've removed that, but kept the line about the operation not being complete until the interrupt is raised since it might possibly make things a little clearer for someone down the line. :P

Although, given that Notch has apparently already taken a copy of this, I'm not sure if there's any point in updating this...

@jonpovey
Copy link

Hooray for IAQ! ;)

@rmmh
Copy link

rmmh commented Apr 26, 2012

Assume you can poke him with a few simplifications.

Are variably-sized sectors worthwhile at all? Why not just standardize on some power of 2 words? (256 or 512 words would probably be good).

@kierdavis
Copy link

If you attempt to write to a writelocked disk, does it fail silently or should it return an error code?

@DanielKeep
Copy link
Author

DanielKeep commented May 6, 2012 via email

@kierdavis
Copy link

kierdavis commented May 7, 2012 via email

@DanielKeep
Copy link
Author

DanielKeep commented May 8, 2012 via email

@grey-lensman
Copy link

Hmm, I read the write-protect signal as a flag one needed to check before attempting to write -- that it was up to the software to respect it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment