1
0
mirror of https://github.com/TomHarte/CLK.git synced 2024-07-27 02:29:12 +00:00

Adds exposition on the meaning of a disk controller being in write mode.

This commit is contained in:
Thomas Harte 2017-09-15 19:14:36 -04:00
parent bf20c717fb
commit 662d031e3c

View File

@ -68,8 +68,11 @@ class Controller: public DigitalPhaseLockedLoop::Delegate, public Drive::EventDe
virtual void process_write_completed(); virtual void process_write_completed();
/*! /*!
Puts the drive returned by get_drive() into write mode, supplying the current bit length Puts the controller and the drive returned by get_drive() into write mode, supplying to
and marks the controller as being in write mode. the drive the current bit length.
While the controller is in write mode it disconnects the PLL. So subclasses will not
receive any calls to @c process_input_bit.
@param clamp_to_index_hole If @c true then writing will automatically be truncated by @param clamp_to_index_hole If @c true then writing will automatically be truncated by
the index hole. Writing will continue over the index hole otherwise. the index hole. Writing will continue over the index hole otherwise.
@ -93,6 +96,9 @@ class Controller: public DigitalPhaseLockedLoop::Delegate, public Drive::EventDe
*/ */
Drive &get_drive(); Drive &get_drive();
/*!
As per Sleeper.
*/
bool is_sleeping(); bool is_sleeping();
private: private: