Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expansion: Add is_connected API to check for VGM #6

Merged
merged 6 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 61 additions & 8 deletions applications/services/expansion/expansion.c
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ typedef enum {
ExpansionStateDisabled,
ExpansionStateEnabled,
ExpansionStateRunning,
ExpansionStateConnectionEstablished,
} ExpansionState;

typedef enum {
Expand All @@ -26,10 +27,15 @@ typedef enum {
ExpansionMessageTypeSetListenSerial,
ExpansionMessageTypeModuleConnected,
ExpansionMessageTypeModuleDisconnected,
ExpansionMessageTypeConnectionEstablished,
ExpansionMessageTypeIsConnected,
} ExpansionMessageType;

typedef union {
FuriHalSerialId serial_id;
union {
FuriHalSerialId serial_id;
bool* is_connected;
};
} ExpansionMessageData;

typedef struct {
Expand Down Expand Up @@ -68,13 +74,21 @@ static void expansion_detect_callback(void* context) {
UNUSED(status);
}

static void expansion_worker_callback(void* context) {
static void expansion_worker_callback(void* context, ExpansionWorkerCallbackReason reason) {
furi_assert(context);
Expansion* instance = context;

ExpansionMessage message = {
.type = ExpansionMessageTypeModuleDisconnected,
.api_lock = NULL, // Not locking the API here to avoid a deadlock
ExpansionMessage message;
switch(reason) {
case ExpansionWorkerCallbackReasonExit:
message.type = ExpansionMessageTypeModuleDisconnected;
message.api_lock = NULL; // Not locking the API here to avoid a deadlock
break;

case ExpansionWorkerCallbackReasonConnected:
message.type = ExpansionMessageTypeConnectionEstablished;
message.api_lock = api_lock_alloc_locked();
break;
};

const FuriStatus status = furi_message_queue_put(instance->queue, &message, FuriWaitForever);
Expand Down Expand Up @@ -105,7 +119,9 @@ static void

if(instance->state == ExpansionStateDisabled) {
return;
} else if(instance->state == ExpansionStateRunning) {
} else if(
instance->state == ExpansionStateRunning ||
instance->state == ExpansionStateConnectionEstablished) {
expansion_worker_stop(instance->worker);
expansion_worker_free(instance->worker);
} else {
Expand All @@ -122,7 +138,8 @@ static void expansion_control_handler_set_listen_serial(
const ExpansionMessageData* data) {
furi_check(data->serial_id < FuriHalSerialIdMax);

if(instance->state == ExpansionStateRunning) {
if(instance->state == ExpansionStateRunning ||
instance->state == ExpansionStateConnectionEstablished) {
expansion_worker_stop(instance->worker);
expansion_worker_free(instance->worker);

Expand Down Expand Up @@ -160,7 +177,8 @@ static void expansion_control_handler_module_disconnected(
Expansion* instance,
const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state != ExpansionStateRunning) {
if(instance->state != ExpansionStateRunning &&
instance->state != ExpansionStateConnectionEstablished) {
return;
}

Expand All @@ -170,6 +188,23 @@ static void expansion_control_handler_module_disconnected(
instance->serial_id, expansion_detect_callback, instance);
}

static void expansion_control_handler_connection_established(
Expansion* instance,
const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state != ExpansionStateRunning &&
instance->state != ExpansionStateConnectionEstablished) {
return;
}

instance->state = ExpansionStateConnectionEstablished;
}

static void
expansion_control_handler_is_connected(Expansion* instance, const ExpansionMessageData* data) {
*data->is_connected = instance->state == ExpansionStateConnectionEstablished;
}

typedef void (*ExpansionControlHandler)(Expansion*, const ExpansionMessageData*);

static const ExpansionControlHandler expansion_control_handlers[] = {
Expand All @@ -178,6 +213,8 @@ static const ExpansionControlHandler expansion_control_handlers[] = {
[ExpansionMessageTypeSetListenSerial] = expansion_control_handler_set_listen_serial,
[ExpansionMessageTypeModuleConnected] = expansion_control_handler_module_connected,
[ExpansionMessageTypeModuleDisconnected] = expansion_control_handler_module_disconnected,
[ExpansionMessageTypeConnectionEstablished] = expansion_control_handler_connection_established,
[ExpansionMessageTypeIsConnected] = expansion_control_handler_is_connected,
};

static int32_t expansion_control(void* context) {
Expand Down Expand Up @@ -249,6 +286,22 @@ void expansion_disable(Expansion* instance) {
api_lock_wait_unlock_and_free(message.api_lock);
}

bool expansion_is_connected(Expansion* instance) {
furi_check(instance);
bool is_connected;

ExpansionMessage message = {
.type = ExpansionMessageTypeIsConnected,
.data.is_connected = &is_connected,
.api_lock = api_lock_alloc_locked(),
};

furi_message_queue_put(instance->queue, &message, FuriWaitForever);
api_lock_wait_unlock_and_free(message.api_lock);

return is_connected;
}

void expansion_set_listen_serial(Expansion* instance, FuriHalSerialId serial_id) {
furi_check(instance);
furi_check(serial_id < FuriHalSerialIdMax);
Expand Down
9 changes: 9 additions & 0 deletions applications/services/expansion/expansion.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,15 @@ void expansion_enable(Expansion* instance);
*/
void expansion_disable(Expansion* instance);

/**
* @brief Check if an expansion module is connected.
*
* @param[in,out] instance pointer to the Expansion instance.
*
* @returns true if the module is connected and initialized, false otherwise.
*/
bool expansion_is_connected(Expansion* instance);

/**
* @brief Enable support for expansion modules on designated serial port.
*
Expand Down
3 changes: 2 additions & 1 deletion applications/services/expansion/expansion_worker.c
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ static bool expansion_worker_handle_state_handshake(

if(furi_hal_serial_is_baud_rate_supported(instance->serial_handle, baud_rate)) {
instance->state = ExpansionWorkerStateConnected;
instance->callback(instance->cb_context, ExpansionWorkerCallbackReasonConnected);
// Send response at previous baud rate
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorNone)) break;
furi_hal_serial_set_br(instance->serial_handle, baud_rate);
Expand Down Expand Up @@ -351,7 +352,7 @@ static int32_t expansion_worker(void* context) {

// Do not invoke worker callback on user-requested exit
if((instance->exit_reason != ExpansionWorkerExitReasonUser) && (instance->callback != NULL)) {
instance->callback(instance->cb_context);
instance->callback(instance->cb_context, ExpansionWorkerCallbackReasonExit);
}

return 0;
Expand Down
8 changes: 7 additions & 1 deletion applications/services/expansion/expansion_worker.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,20 @@
*/
typedef struct ExpansionWorker ExpansionWorker;

typedef enum {
ExpansionWorkerCallbackReasonExit,
ExpansionWorkerCallbackReasonConnected,
} ExpansionWorkerCallbackReason;

/**
* @brief Worker callback type.
*
* @see expansion_worker_set_callback()
*
* @param[in,out] context pointer to a user-defined object.
* @param[in] reason reason for the callback.
*/
typedef void (*ExpansionWorkerCallback)(void* context);
typedef void (*ExpansionWorkerCallback)(void* context, ExpansionWorkerCallbackReason reason);

/**
* @brief Create an expansion worker instance.
Expand Down
1 change: 1 addition & 0 deletions targets/f7/api_symbols.csv
Original file line number Diff line number Diff line change
Expand Up @@ -1033,6 +1033,7 @@ Function,-,exp2l,long double,long double
Function,+,expansion_disable,void,Expansion*
Function,+,expansion_enable,void,Expansion*
Function,+,expansion_get_settings,ExpansionSettings*,Expansion*
Function,+,expansion_is_connected,_Bool,Expansion*
Function,+,expansion_set_listen_serial,void,"Expansion*, FuriHalSerialId"
Function,-,expansion_settings_load,_Bool,ExpansionSettings*
Function,+,expansion_settings_save,_Bool,ExpansionSettings*
Expand Down
Loading