| 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
Data Structures | Typedefs
isf_protocol_adapter.h File Reference

isf_protocol_adapter.h defines the general interface definition for the protocol adapter. More...

`#include "isf_types.h"`
`#include "isf_comm.h"`
Include dependency graph for isf_protocol_adapter.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Data Structures
struct | protocol_t
| This structure contains protocol-specific function pointers and properties. More...
struct | busHandle_struct
| This structure is a declaration of a BusHandle type. More...

## Typedefs
typedef isf_status_t(* | fnInit_t )(comm_Id_t aBusId, void *apBusHandle)
| This is the function pointer signature for bus initialization. More...
typedef comm_State_t(* | fnGetState_t )(void *apBusHandle)
| This is the function pointer signature for getting the state of the bus. More...
typedef isf_status_t(* | fnGetConfig_t )(void *apBusHandle, void *apBusConfig)
| This is the function pointer signature for getting the configuration of the bus. More...
typedef isf_status_t(* | fnConfigure_t )(void *apBusHandle, void *apBusConfig)
| This is the function pointer signature for setting the configuration of the bus. More...
typedef isf_status_t(* | fnStart_t )(void *apBusHandle)
| This is the function pointer signature for starting the bus. More...
typedef isf_status_t(* | fnStop_t )(void *apBusHandle, isf_duration_t aTimeout)
| This is the function pointer signature for stopping the bus. More...
typedef isf_status_t(* | fnConnectToEndpoint_t )(void *apBusHandle, void *apDevice, void **apEndpointHandle)
| This is the function pointer signature for getting the Endpoint handle. More...
typedef isf_status_t(* | fnDisconnectEndpoint_t )(void *apEndpointHandle)
| This is the function pointer signature for closing the Endpoint. More...
typedef isf_status_t(* | fnAcquireLock_t )(void *apBusHandle, isf_duration_t aTimeout)
| This is the function pointer signature for acquiring the lock for a particular bus. More...
typedef isf_status_t(* | fnReleaseLock_t )(void *apBusHandle)
| This is the function pointer signature for releasing the lock for a particular bus. More...
typedef isf_status_t(* | fnRead_t )(void *apEndpointHandle, int32 offset, void *apReadBuffer, uint32 buffsize, uint32 nBytesRead, comm_Flags_t aFlags)
| This is the function pointer signature for reading the data from a specified device. More...
typedef isf_status_t(* | fnWrite_t )(void *apEndpointHandle, int32 offset, uint8 *pWriteBuffer, uint32 buffsize, uint32 nBytesWrite, comm_Flags_t aFlags)
| This is the the function pointer signature for writing the data to a specified device. More...
typedef struct busHandle_struct | busHandle_t
| This structure is a declaration of a BusHandle type. More...

## Detailed Description

isf_protocol_adapter.h defines the general interface definition for the protocol adapter.

File: isf_protocol_adapter.h

Copyright (c) 2014, Freescale Semiconductor, Inc.

Definition in file isf_protocol_adapter.h.

## Typedef Documentation

typedef struct busHandle_struct busHandle_t

This structure is a declaration of a BusHandle type.

typedef isf_status_t(* fnAcquireLock_t)(void *apBusHandle, isf_duration_t aTimeout)

This is the function pointer signature for acquiring the lock for a particular bus.

Definition at line 52 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnConfigure_t)(void *apBusHandle, void *apBusConfig)

This is the function pointer signature for setting the configuration of the bus.

Definition at line 31 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnConnectToEndpoint_t)(void *apBusHandle, void *apDevice, void **apEndpointHandle)

This is the function pointer signature for getting the Endpoint handle.

Definition at line 43 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnDisconnectEndpoint_t)(void *apEndpointHandle)

This is the function pointer signature for closing the Endpoint.

Definition at line 47 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnGetConfig_t)(void *apBusHandle, void *apBusConfig)

This is the function pointer signature for getting the configuration of the bus.

Definition at line 27 of file isf_protocol_adapter.h.

typedef comm_State_t(* fnGetState_t)(void *apBusHandle)

This is the function pointer signature for getting the state of the bus.

Definition at line 23 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnInit_t)(comm_Id_t aBusId, void *apBusHandle)

This is the function pointer signature for bus initialization.

Definition at line 19 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnRead_t)(void *apEndpointHandle, int32 offset, void *apReadBuffer, uint32 buffsize, uint32 nBytesRead, comm_Flags_t aFlags)

This is the function pointer signature for reading the data from a specified device.

Definition at line 60 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnReleaseLock_t)(void *apBusHandle)

This is the function pointer signature for releasing the lock for a particular bus.

Definition at line 56 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnStart_t)(void *apBusHandle)

This is the function pointer signature for starting the bus.

Definition at line 35 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnStop_t)(void *apBusHandle, isf_duration_t aTimeout)

This is the function pointer signature for stopping the bus.

Definition at line 39 of file isf_protocol_adapter.h.

typedef isf_status_t(* fnWrite_t)(void *apEndpointHandle, int32 offset, uint8 *pWriteBuffer, uint32 buffsize, uint32 nBytesWrite, comm_Flags_t aFlags)

This is the the function pointer signature for writing the data to a specified device.

Definition at line 64 of file isf_protocol_adapter.h.

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