SHIPCore:SHIP CAN

From Serious Documentation
Jump to: navigation, search
Subsystem Introduced Description
SHIP_CAN v4.0 Basic CAN framework to encapsulate and abstract hardware-specific peripherals and drivers.

SHIP_CAN is a very simple CAN I/O abstraction enabling raw packet sending and receiving when implemented in the underlying hardware and supported by a board/peripheral-specific driver.

SHIP_CAN is part of SHIPCore, the foundational firmware enabling application development for Serious Communications Modules. SHIPCore is bundled in SHIPWare for Serious Communications Modules which adds the OS, BSP, drivers, and glue on top of SHIPCore to create an out-of-the-box embedded application environment.

Major Version Changes

Version Change
v4.0.0 introduced

Files

  • SHIP_Core/SHIP_CAN.h is the API definition and is automatically included by SHIP_Core.h
  • SHIP_Core/SHIP_CAN.c is the abstracted hardware-independent implementation of the receive/transmit functions

When implemented, the low level hardware/board/peripheral driver file(s) will be present to implement this API on a platform, for example on the SCM117/SCM118 Common/SHIP_CANDriver_MCP2515.c and .h instantiated a low level driver for the Microchip MCP2515 SPI interface CAN chip.

API

Initialization

Examples