salfter/greaseweazle-firmware
1
0
Fork 0
mirror of https://github.com/keirf/greaseweazle-firmware.git synced 2025-10-31 11:06:44 -07:00
Code Issues Packages Projects Releases Wiki Activity

ReadFlux: Allow max_index_post_ticks to be specified by the host.

Browse Source 
Also: Improve USB protocol docs.
This commit is contained in:
Keir Fraser
2021-02-22 15:17:52 +00:00
parent dd4864c216
commit 2b78b953b7
2 changed files with 28 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
inc/cdc_acm_protocol.h
View File

@@ -12,15 +12,18 @@
/*
* GREASEWEAZLE COMMAND SET
*
* NOTE: Commands cannot be pipelined. Do not issue a new command until the
* previous command is completed with all expected bytes received by the host.
*/
/* CMD_GET_INFO, length=3, idx. Returns 32 bytes after ACK. */
#define CMD_GET_INFO 0
/* [BOOTLOADER] CMD_UPDATE, length=6, <update_len>.
* Host follows with <update_len> bytes.
* Host follows after a successful ACK response with <update_len> bytes.
* Bootloader finally returns a status byte, 0 on success. */
/* [MAIN FIRMWARE] CMD_UPDATE, length=10, <update_len>, 0xdeafbee3.
* Host follows with <update_len> bytes.
* Host follows after a successful ACK response with <update_len> bytes.
* Main firmware finally returns a status byte, 0 on success. */
#define CMD_UPDATE 1
/* CMD_SEEK, length=3, cyl#. Seek to cyl# on selected drive. */
@@ -33,15 +36,17 @@
#define CMD_GET_PARAMS 5
/* CMD_MOTOR, length=4, drive#, on/off. Turn on/off a drive motor. */
#define CMD_MOTOR 6
/* CMD_READ_FLUX, length=2-8. Argument is gw_read_flux.
* Returns flux readings until EOStream. */
/* CMD_READ_FLUX, length=8-12. Argument is gw_read_flux; optional fields
* may be omitted. Returns flux readings terminating with EOStream (NUL). */
#define CMD_READ_FLUX 7
/* CMD_WRITE_FLUX, length=2-4. Argument is gw_write_flux.
* Host follows with flux readings until EOStream. */
/* CMD_WRITE_FLUX, length=4. Argument is gw_write_flux.
* Host follows the ACK with flux values terminating with EOStream (NUL).
* Device finally returns a status byte, 0 on success. */
#define CMD_WRITE_FLUX 8
/* CMD_GET_FLUX_STATUS, length=2. Last read/write status returned in ACK. */
#define CMD_GET_FLUX_STATUS 9
/* CMD_SWITCH_FW_MODE, length=3, <mode> */
/* CMD_SWITCH_FW_MODE, length=3, <mode>. No response on success: The device
* resets into the requested mode, and the USB connection also resets. */
#define CMD_SWITCH_FW_MODE 11
/* CMD_SELECT, length=3, drive#. Select drive# as current unit. */
#define CMD_SELECT 12
@@ -152,10 +157,14 @@ struct packed gw_bw_stats {
/* CMD_READ_FLUX */
struct packed gw_read_flux {
/** MANDATORY FIELDS: **/
/* Maximum ticks to read for (or 0, for no limit). */
uint32_t ticks;
/* Maximum index pulses to read (or 0, for no limit). */
uint16_t max_index;
/** OPTIONAL FIELDS: **/
/* Linger time, in ticks, to continue reading after @max_index pulses. */
uint32_t max_index_linger; /* default: 500 microseconds */
};
/* CMD_WRITE_FLUX */