can_config.h File Reference

User-facing CAN bus transport configuration. More...

Go to the source code of this file.

Data Structures
struct	can_config_t
	CAN bus transport configuration. More...

Functions
void	CanConfig_initialize (const can_config_t *config)
	Initializes the CAN bus transport layer.

Detailed Description

User-facing CAN bus transport configuration.

Copyright

Copyright (c) 2025, 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.

Users provide their hardware-specific CAN driver functions here. All other CAN-internal wiring is handled automatically by can_config.c.

Author

Jim Kueneman

Date

4 Mar 2026

See also

openlcb_config.h - OpenLCB protocol layer configuration

Function Documentation

CanConfig_initialize()

void CanConfig_initialize ( const can_config_t * config )

extern

Initializes the CAN bus transport layer.

Must be called BEFORE OpenLcb_initialize().

Parameters

config

Pointer to can_config_t configuration. Must remain valid for the lifetime of the application.

Warning

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

See also

openlcb_config.h

Algorithm:

1. Save the user-provided config pointer.
2. Initialize buffer infrastructure (CanBufferStore, CanBufferFifo).
3. Build all 7 internal interface structs from user config and library functions.
4. Initialize all CAN modules in dependency order: RxMessageHandler, RxStatemachine, TxMessageHandler, TxStatemachine, LoginMessageHandler, LoginStateMachine, MainStatemachine, AliasMappings.

* @param config  Pointer to @ref can_config_t configuration. Must remain
*                valid for the lifetime of the application.
* 

Warning

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

See also

openlcb_config.h