XDK API  3.6.0
Documentation
Functions
Serval_ProfilingPin.h File Reference

An interface to the platform Pin. More...

#include <Serval_Defines.h>
#include <Serval_Types.h>
#include <Serval_Exceptions.h>
+ Include dependency graph for Serval_ProfilingPin.h:

Functions

int ProfilingPin_getPin (int i)
 
retcode_t ProfilingPin_init (int pin)
 
retcode_t ProfilingPin_setStatus (int pin, bool status)
 

Detailed Description

Profiling can be used to do time measurements on the device. Beside that a pin on the platform can be used to watch the activity with an oscilloscope. This module provides methods to initialize a pin on the platform and to set the output data of it.

Used by ServalStack/api/Serval_Profiling.h.

Function Documentation

int ProfilingPin_getPin ( int  i)

This function is called to fetch the platform specific id of the i-th profiling number.

Parameters
[in]iA number of the sequence 1, 2, ..., SERVAL_PROFILING_MAX_NUM_PINS
Returns
The platform specific pin id of the i-th profiling pin. If i is smaller than 1 or larger than SERVAL_PROFILING_MAX_NUM_PINS, then the return value is -1.
retcode_t ProfilingPin_init ( int  pin)

This function is called to sets a specified pin as output.

Parameters
[in]pinThe platform specific id of the pin to be configured. It is retrieved by invoking ProfilingPin_getPin()
Returns
RC_OK if the operation was successful, RC_PROFILING_PIN_ERROR otherwise
See also
ProfilingPin_getPin()
retcode_t ProfilingPin_setStatus ( int  pin,
bool  status 
)

This function is called to set the pin output data to zero or one based on the given status. Before invoking this function ProfilingPin_init() must be invoked.

Parameters
[in]pinThe platform specific id of the pin to be configured.
[in]statusThe platform specific pin output data. Can be set to zero or one
Returns
RC_OK if the operation was successful, RC_PROFILING_PIN_ERROR otherwise
See also
ProfilingPin_init()

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:47 by doxygen 1.8.8