can_login_statemachine.h File Reference

Dispatcher for the 10-state CAN alias allocation login sequence. More...

Go to the source code of this file.

Data Structures
struct	interface_can_login_state_machine_t
	Dependency-injection interface for the CAN login state machine. More...

Functions
void	CanLoginStateMachine_initialize (const interface_can_login_state_machine_t *interface_can_login_state_machine)
	Registers the dependency-injection interface for this module.
void	CanLoginStateMachine_run (can_statemachine_info_t *can_statemachine_info)
	Dispatches to the handler for the node's current run_state.

Detailed Description

Dispatcher for the 10-state CAN alias allocation login sequence.

Copyright

Copyright (c) 2024, Jim Kueneman All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Transitions through INIT -> GENERATE_SEED -> GENERATE_ALIAS -> CID7 -> CID6 -> CID5 -> CID4 -> WAIT_200ms -> RID -> AMD. State handlers are supplied via dependency injection.

Author

Jim Kueneman

Date

4 Mar 2026

Function Documentation

CanLoginStateMachine_initialize()

void CanLoginStateMachine_initialize ( const interface_can_login_state_machine_t * interface_can_login_state_machine )

extern

Registers the dependency-injection interface for this module.

Parameters

interface_can_login_state_machine

Pointer to a populated interface_can_login_state_machine_t. Must remain valid for the lifetime of the application. All 10 function pointers must be non-NULL.

Warning

NOT thread-safe - call during single-threaded initialization only.

See also

CanLoginMessageHandler_initialize - initialize first

CanLoginStateMachine_run

Registers the dependency-injection interface for this module.

CanLoginStateMachine_run()

void CanLoginStateMachine_run ( can_statemachine_info_t * can_statemachine_info )

extern

Dispatches to the handler for the node's current run_state.

Non-blocking - executes exactly one state handler per call and returns. Call repeatedly from the main loop until the node reaches permitted state.

Parameters

can_statemachine_info

State machine context (node + outgoing message buffer).

Warning

can_statemachine_info must not be NULL.

NOT thread-safe.

See also

CanLoginMessageHandler_state_init - entry point

CanLoginMessageHandler_state_load_amd - final state

Dispatches to the handler for the node's current run_state.

* @param can_statemachine_info State machine context (node + login frame buffer).
*