| ISF 2.1 Intelligent Sensing Framework for Kinetis with Processor Expert

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Typedefs | Enumerations
isf_comm.h File Reference

isf_comm.h defines the common types for the Communications Service Family of the Intelligent Sensing Framework (ISF). More...

`#include <isf.h>`
Include dependency graph for isf_comm.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Typedefs
typedef uint32 | comm_Id_t
| This type is for a numeric channel identifier- index into an array of channels in the system. More...
typedef enum comm_State_vals | comm_State_t
| This enum holds an enumerated value describing the state of a channel. More...
typedef uint32 | comm_Address_t
| This type is for a channel address for both 7-bit and 10-bit addresses. More...
typedef uint8 | comm_Flags_t
| This is a bit array of flags governing device read/write behavior. More...

## Enumerations
enum | comm_State_vals { COMM_STATE_NO_INIT = 0, COMM_STATE_INIT = 1, COMM_STATE_OK = 2, COMM_STATE_STOPPED = 3, COMM_STATE_ERROR = 5, COMM_STATE_ARB_LOST = 6 }
| This enum defines the possible communications channel states. More...
enum | comm_Error_vals { COMM_ERROR_INIT = 1, COMM_ERROR_STOP = 2, COMM_ERROR_LOCK = 3, COMM_ERROR_TIME_OUT = 4, COMM_ERROR_NULL_PTR = 5, COMM_ERROR_NOEXIST = 6, COMM_ERROR_BUF_SIZE = 7, COMM_ERROR_NO_ACK = 8, COMM_ERROR_DEV_CLOSED = 9, COMM_ERROR_OTHER = 10 }
| This enum defines the possible communications channel error codes. More...

## Detailed Description

isf_comm.h defines the common types for the Communications Service Family of the Intelligent Sensing Framework (ISF).

File: isf_comm.h

Copyright (c) 2012, Freescale Semiconductor, Inc.

This common types used by components in the ISF Communications Service Family, including the I2C and Device Messaging Components. Since the Device Messaging Component abstracts various communications interfaces (I2C, SPI, RGPIO), it is important to ensure that all abstracted components use common data types and function prototypes. These types and prototypes are defined in the header file rather than in the Device Messaging header file to avoid creating a circular dependency.

Definition in file isf_comm.h.

## Typedef Documentation

typedef uint32 comm_Address_t

This type is for a channel address for both 7-bit and 10-bit addresses.

Definition at line 56 of file isf_comm.h.

typedef uint8 comm_Flags_t

This is a bit array of flags governing device read/write behavior.

Definition at line 59 of file isf_comm.h.

typedef uint32 comm_Id_t

This type is for a numeric channel identifier- index into an array of channels in the system.

Definition at line 50 of file isf_comm.h.

typedef enum comm_State_vals comm_State_t

This enum holds an enumerated value describing the state of a channel.

Definition at line 53 of file isf_comm.h.

## Enumeration Type Documentation

enum comm_Error_vals

This enum defines the possible communications channel error codes.

Enumerator
COMM_ERROR_INIT | A channel initialization error has occurred.
COMM_ERROR_STOP | A channel stop-related error has occurred.
COMM_ERROR_LOCK | A channel lock-related error has occurred.
COMM_ERROR_TIME_OUT | Channel has timed out.
COMM_ERROR_NULL_PTR | A null pointer was provided as an argument.
COMM_ERROR_NOEXIST | The referenced entity does not exist.
COMM_ERROR_BUF_SIZE | The provided buffer is too small.
COMM_ERROR_NO_ACK | An acknowledgement was not received.
COMM_ERROR_DEV_CLOSED | Attempted read/write to a closed device.
COMM_ERROR_OTHER | An unspecified channel error has occured.

Definition at line 35 of file isf_comm.h.

enum comm_State_vals

This enum defines the possible communications channel states.

Enumerator
COMM_STATE_NO_INIT | Channel has not been initialized.
COMM_STATE_INIT | Channel is initialized, but not ready to use because channel is not started or configured.
COMM_STATE_OK | Channel is ready to use without errors.
COMM_STATE_STOPPED | Channel is currently stopped.
COMM_STATE_ERROR | A null pointer was provided as an argument.
COMM_STATE_ARB_LOST | Channel arbitration has been lost.

Definition at line 25 of file isf_comm.h.

- © Freescale Semiconductor, Inc. 2015. All Rights Reserved.