Skip to content

Commit

Permalink
Attempt #2?
Browse files Browse the repository at this point in the history
  • Loading branch information
tzarc committed Mar 6, 2024
1 parent 5835198 commit c962a18
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 34 deletions.
89 changes: 65 additions & 24 deletions quantum/encoder.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,26 @@ void encoder_init(void) {
}

static bool encoder_handle_queue(void) {
bool changed = false;
while (encoder_events.tail != encoder_events.head) {
encoder_event_t event = encoder_events.queue[encoder_events.tail];
encoder_events.tail = (encoder_events.tail + 1) % MAX_QUEUED_ENCODER_EVENTS;

bool changed = false;
uint8_t index;
bool clockwise;
while (encoder_dequeue_event(&index, &clockwise)) {
#ifdef ENCODER_MAP_ENABLE

// The delays below cater for Windows and its wonderful requirements.
action_exec(event.clockwise ? MAKE_ENCODER_CW_EVENT(event.index, true) : MAKE_ENCODER_CCW_EVENT(event.index, true));
action_exec(clockwise ? MAKE_ENCODER_CW_EVENT(index, true) : MAKE_ENCODER_CCW_EVENT(index, true));
# if ENCODER_MAP_KEY_DELAY > 0
wait_ms(ENCODER_MAP_KEY_DELAY);
# endif // ENCODER_MAP_KEY_DELAY > 0

action_exec(event.clockwise ? MAKE_ENCODER_CW_EVENT(event.index, false) : MAKE_ENCODER_CCW_EVENT(event.index, false));
action_exec(clockwise ? MAKE_ENCODER_CW_EVENT(index, false) : MAKE_ENCODER_CCW_EVENT(index, false));
# if ENCODER_MAP_KEY_DELAY > 0
wait_ms(ENCODER_MAP_KEY_DELAY);
# endif // ENCODER_MAP_KEY_DELAY > 0

#else // ENCODER_MAP_ENABLE

encoder_update_kb(event.index, event.clockwise ? true : false);
encoder_update_kb(index, clockwise);

#endif // ENCODER_MAP_ENABLE

Expand Down Expand Up @@ -72,39 +71,81 @@ bool encoder_task(void) {
return changed;
}

bool encoder_queue_event(uint8_t index, bool clockwise) {
bool encoder_queue_full_advanced(encoder_events_t *events) {
return events->head == (events->tail - 1) % MAX_QUEUED_ENCODER_EVENTS;
}

bool encoder_queue_full(void) {
return encoder_queue_full_advanced(&encoder_events);
}

bool encoder_queue_empty_advanced(encoder_events_t *events) {
return events->head == events->tail;
}

bool encoder_queue_empty(void) {
return encoder_queue_empty_advanced(&encoder_events);
}

bool encoder_queue_event_advanced(encoder_events_t *events, uint8_t index, bool clockwise) {
// Drop out if we're full
if ((encoder_events.head + 1) % MAX_QUEUED_ENCODER_EVENTS == encoder_events.tail) {
if (encoder_queue_full_advanced(events)) {
return false;
}

// Append the event
encoder_event_t new_event = {.index = index, .clockwise = clockwise ? 1 : 0};
encoder_events.queue[encoder_events.head] = new_event;
encoder_event_t new_event = {.index = index, .clockwise = clockwise ? 1 : 0};
events->queue[events->head] = new_event;

// Increment the head index
encoder_events.head = (encoder_events.head + 1) % MAX_QUEUED_ENCODER_EVENTS;
events->head = (events->head + 1) % MAX_QUEUED_ENCODER_EVENTS;
events->enqueued++;

// dprintf("Enqueued event: %d %s [h=%d,t=%d,e=%d,d=%d]\n", (int)index, clockwise ? "CW" : "CCW", (int)events->head, (int)events->tail, (int)events->enqueued, (int)events->dequeued);

return true;
}

bool encoder_dequeue_event_advanced(encoder_events_t *events, uint8_t *index, bool *clockwise) {
if (encoder_queue_empty_advanced(events)) {
return false;
}

// Retrieve the event
encoder_event_t event = events->queue[events->tail];
*index = event.index;
*clockwise = event.clockwise;

// Increment the tail index
events->tail = (events->tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
events->dequeued++;

// dprintf("Dequeued event: %d %s [h=%d,t=%d,e=%d,d=%d]\n", (int)*index, *clockwise ? "CW" : "CCW", (int)events->head, (int)events->tail, (int)events->enqueued, (int)events->dequeued);

return true;
}

bool encoder_queue_event(uint8_t index, bool clockwise) {
return encoder_queue_event_advanced(&encoder_events, index, clockwise);
}

bool encoder_dequeue_event(uint8_t *index, bool *clockwise) {
return encoder_dequeue_event_advanced(&encoder_events, index, clockwise);
}

void encoder_retrieve_events(encoder_events_t *events) {
memcpy(events, &encoder_events, sizeof(encoder_events));
}

#ifdef SPLIT_KEYBOARD
void encoder_set_tail_index(uint8_t tail_index) {
encoder_events.tail = tail_index;
}
void encoder_queue_drain(void) {
uint8_t index;
bool clockwise;

void encoder_handle_slave_events(encoder_events_t *events) {
if (events->tail >= MAX_QUEUED_ENCODER_EVENTS || events->head >= MAX_QUEUED_ENCODER_EVENTS) {
return;
}
while (events->tail != events->head) {
encoder_event_t event = events->queue[events->tail];
events->tail = (events->tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
encoder_queue_event(event.index, event.clockwise ? true : false);
// dprintf("Draining encoder queue\n");

while (encoder_events.dequeued != encoder_events.enqueued) {
encoder_dequeue_event(&index, &clockwise);
}
}
#endif // SPLIT_KEYBOARD
Expand Down
10 changes: 8 additions & 2 deletions quantum/encoder.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ __attribute__((weak)) bool should_process_encoder(void);
void encoder_init(void);
bool encoder_task(void);
bool encoder_queue_event(uint8_t index, bool clockwise);
bool encoder_dequeue_event(uint8_t *index, bool *clockwise);

bool encoder_update_kb(uint8_t index, bool clockwise);
bool encoder_update_user(uint8_t index, bool clockwise);
Expand Down Expand Up @@ -82,6 +83,8 @@ typedef struct encoder_event_t {
} encoder_event_t;

typedef struct encoder_events_t {
uint16_t enqueued;
uint16_t dequeued;
uint8_t head;
uint8_t tail;
encoder_event_t queue[MAX_QUEUED_ENCODER_EVENTS];
Expand All @@ -90,9 +93,12 @@ typedef struct encoder_events_t {
// Get the current queued events
void encoder_retrieve_events(encoder_events_t *events);

// Encoder event queue management
bool encoder_queue_event_advanced(encoder_events_t *events, uint8_t index, bool clockwise);
bool encoder_dequeue_event_advanced(encoder_events_t *events, uint8_t *index, bool *clockwise);

# ifdef SPLIT_KEYBOARD
void encoder_set_tail_index(uint8_t tail_index);
void encoder_handle_slave_events(encoder_events_t *events);
void encoder_queue_drain(void);
# endif // SPLIT_KEYBOARD

# ifdef ENCODER_MAP_ENABLE
Expand Down
2 changes: 1 addition & 1 deletion quantum/split_common/transaction_id_define.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ enum serial_transaction_id {
#ifdef ENCODER_ENABLE
GET_ENCODERS_CHECKSUM,
GET_ENCODERS_DATA,
PUT_ENCODER_TAIL,
CMD_ENCODER_DRAIN,
#endif // ENCODER_ENABLE

#ifndef DISABLE_SYNC_TIMER
Expand Down
25 changes: 18 additions & 7 deletions quantum/split_common/transactions.c
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,12 @@
{ 0, 0, sizeof_member(split_shared_memory_t, member), offsetof(split_shared_memory_t, member), cb }
#define trans_target2initiator_initializer(member) trans_target2initiator_initializer_cb(member, NULL)

#define trans_initiator2target_cb(cb) \
{ 0, 0, 0, 0, cb }

#define transport_write(id, data, length) transport_execute_transaction(id, data, length, NULL, 0)
#define transport_read(id, data, length) transport_execute_transaction(id, NULL, 0, data, length)
#define transport_exec(id) transport_execute_transaction(id, NULL, 0, NULL, 0)

#if defined(SPLIT_TRANSACTION_IDS_KB) || defined(SPLIT_TRANSACTION_IDS_USER)
// Forward-declare the RPC callback handlers
Expand Down Expand Up @@ -239,8 +243,17 @@ static bool encoder_handlers_master(matrix_row_t master_matrix[], matrix_row_t s

bool okay = read_if_checksum_mismatch(GET_ENCODERS_CHECKSUM, GET_ENCODERS_DATA, &last_update, &temp_events, &split_shmem->encoders.events, sizeof(temp_events));
if (okay) {
encoder_handle_slave_events(&temp_events);
transport_write(PUT_ENCODER_TAIL, &temp_events.tail, sizeof(temp_events.tail));
bool actioned = false;
uint8_t index;
bool clockwise;
while (okay && encoder_dequeue_event_advanced(&split_shmem->encoders.events, &index, &clockwise)) {
okay &= encoder_queue_event(index, clockwise);
actioned = true;
}

if (actioned) {
transport_exec(CMD_ENCODER_DRAIN);
}
}
return okay;
}
Expand All @@ -252,10 +265,8 @@ static void encoder_handlers_slave(matrix_row_t master_matrix[], matrix_row_t sl
split_shmem->encoders.checksum = crc8(&split_shmem->encoders.events, sizeof(split_shmem->encoders.events));
}

static void encoder_handlers_slave_reset(uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer) {
uint8_t tail_index = *(uint8_t *)initiator2target_buffer;
encoder_set_tail_index(tail_index); // no need to update shmem's tail as `[PUT_ENCODER_TAIL]` has already done so
split_shmem->encoders.checksum = crc8(&split_shmem->encoders.events, sizeof(split_shmem->encoders.events));
static void encoder_handlers_slave_drain(uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer) {
encoder_queue_drain();
}

// clang-format off
Expand All @@ -264,7 +275,7 @@ static void encoder_handlers_slave_reset(uint8_t initiator2target_buffer_size, c
# define TRANSACTIONS_ENCODERS_REGISTRATIONS \
[GET_ENCODERS_CHECKSUM] = trans_target2initiator_initializer(encoders.checksum), \
[GET_ENCODERS_DATA] = trans_target2initiator_initializer(encoders.events), \
[PUT_ENCODER_TAIL] = trans_initiator2target_initializer_cb(encoders.events.tail, encoder_handlers_slave_reset),
[CMD_ENCODER_DRAIN] = trans_initiator2target_cb(encoder_handlers_slave_drain),
// clang-format on

#else // ENCODER_ENABLE
Expand Down

0 comments on commit c962a18

Please sign in to comment.