Difference between revisions of "SHIPCore:SHIP SPIM"

From Serious Documentation
Jump to: navigation, search
(Created page with "__NOTOC__ {{WareSubsystemTableStart|}}<onlyinclude> |SHIPCore:SHIP_SPIM|SHIP_SPIM||style="text-align:center;"|v4.0||SPI Master framework to encapsulate hardware-specific perip...")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{WareSubsystemTableStart|}}<onlyinclude>
 
{{WareSubsystemTableStart|}}<onlyinclude>
−
|SHIPCore:SHIP_SPIM|SHIP_SPIM||style="text-align:center;"|v4.0||SPI Master framework to encapsulate hardware-specific peripherals and drivers.</onlyinclude>
+
|[[SHIPCore:SHIP_SPIM|SHIP_SPIM]]||style="text-align:center;"|v4.0||SPI Master framework to encapsulate hardware-specific peripherals and drivers.</onlyinclude>
 
|}
 
|}
−
SHIPCore:SHIP_SPIM|SHIP_SPIM is an SPI Master driver framework supporting:
+
[[SHIPCore:SHIP_SPIM|SHIP_SPIM]] is an SPI Master driver framework supporting:
 
* Hardware-independent API
 
* Hardware-independent API
 
* Multiple different types of concurrent underlying SPI hardware peripherals through plug-in drivers
 
* Multiple different types of concurrent underlying SPI hardware peripherals through plug-in drivers
Line 9: Line 9:
 
* Optional error return values clearly describing the reason a function may have failed, including timeouts
 
* Optional error return values clearly describing the reason a function may have failed, including timeouts
  
−
SHIP_SPIM is part of [[SHIPCore]], the foundational firmware enabling application development for [[SCMs|''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.
+
[[SHIPCore:SHIP_SPIM|SHIP_SPIM]] is part of [[SHIPCore]], the foundational firmware enabling application development for [[SCMs|''Serious'' Communications Modules]]. SHIPCore is bundled in [[SHIPWare]] for [[SCMs|''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==
 
==Major Version Changes==
Line 33: Line 33:
  
 
[[Category:SHIPCore|!]]
 
[[Category:SHIPCore|!]]
−
[[Category:NoIndex]]
 

Revision as of 09:04, 24 January 2017

Subsystem Introduced Description
SHIP_SPIM v4.0 SPI Master framework to encapsulate hardware-specific peripherals and drivers.

SHIP_SPIM is an SPI Master driver framework supporting:

  • Hardware-independent API
  • Multiple different types of concurrent underlying SPI hardware peripherals through plug-in drivers
  • Bus locking and support for multiple targets (SPMT's) on the same bus
  • Optional error return values clearly describing the reason a function may have failed, including timeouts

SHIP_SPIM 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_SPIM.h is the API definition and is automatically included by SHIP_Core.h
  • SHIP_Core/SHIP_SPIM.c is the abstracted hardware-independent implementation of the bus locking and encapsulating array of the driver descriptors per port

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 SCM118, Common/SPIMDriver.c instantiate a low level driver for the Renesas MCU's RSPI peripheral.

API

Initialization

Examples

Retrieved from "https://techref.myserious.com/index.php?title=SHIPCore:SHIP_SPIM&oldid=6948"