/*******************************************************************************\r
* (c) Copyright 2009 Actel Corporation. All rights reserved.\r
- * \r
+ *\r
* SmartFusion ACE driver public API.\r
*\r
* SVN $Revision: 2884 $\r
\95 Sigma Delta Digital to Analog Converters (SDD) control\r
\95 Direct analog block configuration and usage\r
\r
- \r
+\r
Initialization\r
The ACE driver is initialized through a call to the ACE_init() function. The\r
ACE_init() function must be called before any other ACE driver functions can\r
be called. It initializes the ACE\92s internal data.\r
\r
- \r
+\r
Reading analog input channels values and properties\r
The ACE driver allows retrieving the most recent post processed sample value\r
for each analog input. It also allows retrieving the name of the analog input\r
\95 const uint8_t * ACE_get_channel_name( ace_channel_handle_t channel_handle )\r
\95 channel_type_t ACE_get_channel_type( ace_channel_handle_t channel_handle )\r
\r
- \r
+\r
Post Processing Engine flags\r
The SmartFusion ACE Post Processing Engine (PPE) provides the ability to monitor\r
the state of analog input channels and detect when certain threshold values are\r
\95 ace_flag_handle_t ACE_get_flag_handle (const uint8_t *p_sz_full_flag_name)\r
\95 ace_flag_handle_t ACE_get_channel_first_flag (ace_channel_handle_t channel_handle, uint16_t *iterator)\r
\95 ace_flag_handle_t ACE_get_channel_next_flag (ace_channel_handle_t channel_handle, uint16_t *iterator)\r
- \r
+\r
The current status of a flag can be polled using the following function:\r
\95 int32_t ACE_get_flag_status (ace_flag_handle_t flag_handle)\r
\r
\95 const uint8_t * ACE_get_flag_name (ace_flag_handle_t flag_handle)\r
\95 ace_channel_handle_t ACE_get_flag_channel (ace_flag_handle_t flag_handle)\r
\r
- \r
+\r
Conversion to and from real world units\r
The ACE driver provides a set of conversion functions to convert sample values\r
read from the post processing engine into real world units:\r
PPE sample values. These functions are typically used for dynamically adjusting\r
flags threshold values.\r
\r
- \r
+\r
Sample Sequencing Engine control\r
The ACE driver provides a set of functions for dynamically controlling the\r
Sample Sequencing Engine. These functions are only required for managing multiple\r
sampling sequences. The use of these functions is not required for most applications\r
since the SSE is already configured and running by the time the application starts.\r
\r
- \r
+\r
Sample Sequencing Engine Interrupts Control\r
The ACE driver provides a set of functions for managing interrupts generated by\r
the Sample Sequencing Engine. These functions allow enabling, disabling and clearing\r
interrupt defined as part of the sampling sequence. These functions also allow\r
controlling interrupts generated by the ADCs.\r
\r
- \r
+\r
Comparators control\r
The ACE driver provides a set of functions for managing interrupts generated based\r
on the change of state of the high speed comparators. Functions are also provided\r
to dynamically modify the comparators configuration.\r
\r
- \r
+\r
Sigma Delta Digital to Analog Converters (SDD) control\r
The ACE driver provides functions for controlling the output value of the Sigma\r
Delta DACs (SDD). Functions are also provided for dynamically adjusting the\r
\r
#ifdef __cplusplus\r
extern "C" {\r
-#endif \r
+#endif\r
\r
-#include "../../drivers_config/mss_ace/ace_handles.h"\r
+#include "ace_handles.h"\r
\r
/*-------------------------------------------------------------------------*//**\r
Analog to Digital Converter channel IDs.\r
/*==============================================================================\r
============== Direct Analog Block Configuration and Usage ====================\r
=============================================================================*/\r
- \r
+\r
/*=========================================================================*//**\r
@defgroup group1 Direct Analog Block Configuration and Usage\r
These functions are intended for using the SmartFusion analog block hardware\r
channel identified by the channel_id parameter. This function is provided for\r
test purposes. It must not be used while the Sample Sequencing Engine is\r
running.\r
- \r
+\r
@param channel_id\r
The channel_id parameter identifies the analog input channel to sample.\r
- \r
+\r
@return\r
This function does not return a value.\r
*/\r
/*-------------------------------------------------------------------------*//**\r
The ACE_get_adc_result () function reads the result of the last input channel\r
sampling performed by the ADC identified as parameter.\r
- \r
+\r
@param adc_id\r
The adc_id parameter identifies which of the possible three ADC to read the\r
sample result from.\r
- \r
+\r
@return\r
The ACE_start_adc_sync() function returns the ADC result from the ADC\r
specified as parameter.\r
/*-------------------------------------------------------------------------*//**\r
The sdd_id_t enumeration is used to identify the Sigma Delta DACs to the SDD\r
control functions, ACE_configure_sdd(), ACE_enable_sdd(), ACE_disable_sdd()\r
- and ACE_set_sdd_value(). There is one SDD per analog module. \r
+ and ACE_set_sdd_value(). There is one SDD per analog module.\r
*/\r
typedef enum\r
{\r
\r
/*-------------------------------------------------------------------------*//**\r
The sdd_resolution_t enumeration is used as a parameter to the\r
- ACE_configure_sdd() function to specify DAC resolution of the Sigma Delta DAC. \r
+ ACE_configure_sdd() function to specify DAC resolution of the Sigma Delta DAC.\r
*/\r
typedef enum\r
{\r
more important than accuracy.\r
A call to this function is not required if relying on the configuration\r
selected in the ACE configurator being loaded after reset by the system boot.\r
- \r
+\r
@param sdd_id\r
The sdd_id parameter specifies which Sigma Delta DAC is configured by this\r
function. Allowed values are:\r
- SDD0_OUT\r
- SDD1_OUT\r
- SDD2_OUT\r
- \r
+\r
@param resolution\r
The resolution parameter specifies the desired resolution of the Sigma Delta DAC.\r
Allowed values are:\r
- SDD_8_BITS\r
- SDD_16_BITS\r
- SDD_24_BITS\r
- \r
+\r
@param mode\r
The mode parameter specifies the operating mode of the Sigma Delta DAC. It\r
specifies whether a current or voltage should be generated and whether\r
- SDD_VOLTAGE_MODE\r
- SDD_RETURN_TO_ZERO\r
- SDD_NON_RTZ\r
- \r
+\r
@param sync_update\r
The sync_update parameter specifies whether the SDD output will be updated\r
individually though a call to ACE_set_sdd_value() or synchronously with one\r
);\r
\r
/*-------------------------------------------------------------------------*//**\r
- The ACE_enable_sdd() function is used to enable a Sigma Delta DAC. \r
- \r
+ The ACE_enable_sdd() function is used to enable a Sigma Delta DAC.\r
+\r
@param sdd_id\r
The sdd_id parameter specifies the Sigma Delta DAC to enable.\r
*/\r
\r
/*-------------------------------------------------------------------------*//**\r
The ACE_disable_sdd() function is used to disable a Sigma Delta DAC.\r
- \r
+\r
@param sdd_id\r
The sdd_id parameter specifies the Sigma Delta DAC to disable.\r
*/\r
the SDD resolution into account. A maximum voltage of 2.56V or a maximum\r
current of 256uA will be generated when the sdd_value is set the maximum value\r
allowed by the SDD resolution\r
- \r
+\r
@param sdd_id\r
The sdd_id parameter specifies which Sigma Delta DAC is being set.\r
- \r
+\r
@param sdd_value\r
The sdd_value parameter specifies the value of the Sigma Delta DAC output.\r
It is a fraction of SDD resolution. The voltage/current value generated from\r
subsequently used as parameter to function ACE_get_ppe_sample() used to read\r
the most recent post processed sample for the analog input identified through\r
the channel/service name passed as argument to this function.\r
- \r
+\r
@param p_sz_channel_name\r
The p_sz_channel_name parameter is a zero-terminated string containing the\r
name of the channel/service as entered in the ACE configurator.\r
- \r
+\r
@return\r
This function returns a channel handle. This channel handle is required as\r
parameter to function ACE_get_ppe_sample().\r
It will return INVALID_CHANNEL_HANDLE if the channel/service name is not\r
recognized.\r
- \r
+\r
@code\r
uint16_t adc_result;\r
ace_channel_handle_t at0;\r
/*-------------------------------------------------------------------------*//**\r
The ACE_get_input_channel_handle() function returns the channel handle for\r
the hardware analog input channel specified as parameter.\r
- \r
+\r
@param channel_id\r
The channel_id parameter identifies a hardware analog input of the ACE.\r
- \r
+\r
@return\r
This function returns a channel handle. This channel handle is required as\r
parameter to other ACE driver functions dealing with analog inputs.\r
The ACE_get_ppe_sample() function is used to read the most recent post\r
processed sample for the analog input channel associated with the channel\r
handle passed as parameter.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies the analog input channel for which\r
this function will return the most recent ADC conversion result adjusted for\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
This function returns a 16 bit value representing the adjusted value of the\r
ADC conversion result for the analog input channel identified by the channel\r
handle passed as parameter. The return value is actually a 12, 10 or 8 bits\r
number depending on the configuration of the ADC.\r
- \r
+\r
@code\r
uint16_t adc_result;\r
ace_channel_handle_t at0;\r
associated with the channel handle passed as parameter. The channel name is\r
the name used in the ACE configurator software tool when adding a service to\r
the ACE.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies the analog input channel for which\r
we want to retrieve the channel name. The available channel handle values can\r
to ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
This function returns a pointer to a zero-terminated string containing the\r
name of the channel. It returns 0 if the channel handle passed as parameter\r
analog input channel identified by the channel handle passed as parameter.\r
This function allows determining whether the quantity measured through the ADC\r
is a voltage, current or temperature.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
This function returns one of the following values to report the type of\r
quantity measure throught the channel:\r
The ACE_get_channel_count() function returns the total number of configured\r
analog input channels. It is the number of channels available for use as\r
opposed to the theorical number of physical channels supported by the device.\r
- \r
+\r
@return\r
The ACE_get_channel_count() function returns the total number of input\r
channels that were configured in the ACE configurator.\r
The ACE_get_channel_count() function returns 0 if no input channels were\r
configured.\r
- \r
+\r
@code\r
uint32_t inc;\r
uint32_t nb_of_channels;\r
ace_channel_handle_t current_channel;\r
- \r
+\r
nb_of_channels = ACE_get_channel_count();\r
current_channel = ACE_get_first_channel();\r
- \r
+\r
for (inc = 0; inc < nb_of_channels; ++inc)\r
{\r
adc_result = ACE_get_ppe_sample( current_channel );\r
The ACE_get_first_channel() function returns the channel handle of one of the\r
channel controlled by the ACE. This function is used to start iterating though\r
the list of analog input channels handled by the ACE.\r
- \r
+\r
@return\r
The ACE_get_first_channel() function returns the first channel handle found\r
in the ACE driver's internal channel handles list or INVALID_CHANNEL_HANDLE\r
if there are no channels defined in the ACE configuration.\r
- \r
+\r
@code\r
uint32_t inc;\r
uint32_t nb_of_channels;\r
ace_channel_handle_t current_channel;\r
- \r
+\r
nb_of_channels = ACE_get_channel_count();\r
current_channel = ACE_get_first_channel();\r
- \r
+\r
for (inc = 0; inc < nb_of_channels; ++inc)\r
{\r
adc_result = ACE_get_ppe_sample( current_channel );\r
The ACE_get_next_channel() returns the channel handle of the channel following\r
the one passed as parameter. This function is used to iterate through the list\r
of analog input channels handled by the ACE.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies from which channel the driver should\r
look in its channel handle list to return the next channel handle. The\r
channel_handle returned by a previous call to ACE_get_first_channel(). The\r
second and subsequent calls to ACE_get_next_channel() would typically use\r
the channel_handle returned by a previous call to ACE_get_next_channel().\r
- \r
+\r
@return\r
The ACE_get_next_channel() function returns the channel handle of the channel\r
following the one passed as parameter or INVALID_CHANNEL_HANDLE if the end of\r
the channels list has been reached.\r
- \r
+\r
@code\r
uint32_t inc;\r
uint32_t nb_of_channels;\r
ace_channel_handle_t current_channel;\r
- \r
+\r
nb_of_channels = ACE_get_channel_count();\r
current_channel = ACE_get_first_channel();\r
- \r
+\r
for (inc = 0; inc < nb_of_channels; ++inc)\r
{\r
adc_result = ACE_get_ppe_sample( current_channel );\r
Sequencing Engine sequence identified by the sequence name passed as parameter.\r
The sequence handler can then be used as parameter to other SSE sequence control\r
functions to identify the sequence to control.\r
- \r
+\r
@param p_sz_sequence_name\r
The p_sz_sequence_name parameter is a pointer to a zero-terminated string\r
containing the name of the sampling sequence for which we want to retrieve\r
the handle.\r
- \r
+\r
@return\r
The ACE_get_sse_seq_handle() function returns the handle used to identify\r
the sequence passed as parameter with other ACE driver sampling sequence\r
control functions. It returns INVALID_SSE_SEQ_HANDLE if the sequence name\r
passed as parameter is not recognized.\r
- \r
+\r
@code\r
sse_sequence_handle_t sse_seq_handle;\r
sse_seq_handle = ACE_get_sse_seq_handle("ProcedureA");\r
The ACE_load_sse() function loads the ACE Sample Sequencing Engine (SSE) RAM\r
with the microcode implementing the sampling sequence identified by the SSE\r
sequence handler passed as parameter.\r
- \r
+\r
@param sequence\r
The sequence parameter is the SSE sequence handler identifying the sampling\r
sequence to load into the ACE SSE. The value for this handler is retrieved\r
before the loop part of the sequence is started.\r
You must ensure that the sampling sequence has been loaded into the ACE's SSE\r
before calling this function.\r
- \r
+\r
@param sequence\r
The sequence parameter is the SSE sequence handler identifying the sampling\r
sequence to load into the ACE SSE. The value for this handler is retrieved\r
intialization phase of the sequence.\r
This function would typically be called after stopping the sampling sequence\r
using the ACE_stop_see() function or with non-repeating sequences.\r
- \r
+\r
@param sequence\r
The sequence parameter is the SSE sequence handler identifying the sampling\r
sequence to load into the ACE SSE. The value for this handler is retrieved\r
/*-------------------------------------------------------------------------*//**\r
The ACE_stop_sse() function stops execution of the Sample Sequencing Engine\r
(SSE) sequence indentified by the sequence handle passed as parameter.\r
- \r
+\r
@param sequence\r
The sequence parameter is the SSE sequence handle identifying the sampling\r
sequence to load into the ACE SSE. The value for this handler is retrieved\r
sampling sequence identified by the sequence handle passed as parameter to\r
resume execution. This function is typically used to restart execution of\r
a sequence at the point where it was stopped through a call to ACE_stop_sse().\r
- \r
+\r
@param sequence\r
The sequence parameter is the SSE sequence handler identifying the sampling\r
sequence to load into the ACE SSE. The value for this handler is retrieved\r
post processed samples within the ACE hardware. It is intended for use when\r
switching between sampling sequences and using peripheral DMA. It avoids\r
receiving stale samples generated as a result of a previous sampling sequence.\r
- \r
+\r
The example below shows how this function can be used to ensure that no sample\r
generated as a result of sampling sequence sequence_a will be generated once\r
sampling sequence_b is started. Please note that it is important to stop the\r
ACE_clear_sample_pipeline();\r
ACE_start_sse(sequence_b);\r
@endcode\r
- \r
+\r
The example below shows how to ensure that the first sample read through PDMA\r
will be from the first channel in the sampling sequence.\r
@code\r
ACE_restart_sse(sequence_a);\r
PDMA_start\r
(\r
- PDMA_CHANNEL_0, \r
- PDMA_ACE_PPE_DATAOUT, \r
- (uint32_t)g_samples_buffer[g_pdma_buffer_idx], \r
+ PDMA_CHANNEL_0,\r
+ PDMA_ACE_PPE_DATAOUT,\r
+ (uint32_t)g_samples_buffer[g_pdma_buffer_idx],\r
SAMPLES_BUFFER_SIZE\r
);\r
@endcode\r
/*-------------------------------------------------------------------------*//**\r
The ACE_enable_sse_irq() function enables the Sample Sequencing Engine (SSE)\r
interrupt source specified as parameter to generate interrupts.\r
- \r
+\r
@param sse_irq_id\r
The sse_irq_id parameter identifies the SSE interrupt source controlled by\r
this function.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_disable_sse_irq() function disables the Sample Sequencing Engine\r
(SSE) interrupt source specified as parameter from generating interrupts.\r
- \r
+\r
@param sse_irq_id\r
The sse_irq_id parameter identifies the SSE interrupt source controlled by\r
this function.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_clear_sse_irq() function clears the Sampling Sequencing Engine (SSE)\r
interrupt specified as parameter.\r
- \r
+\r
@param sse_irq_id\r
The sse_irq_id parameter identifies the SSE interrupt source controlled by\r
this function.\r
The ACE_set_comp_reference() function is used to select the reference input\r
of a temperature monitor block comparator. The reference input of a temperature\r
monitor can be an ADC direct input or one of the SDD's output.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies the comparator for which to select the\r
- reference input. Since only temperature monitor block comparators have a \r
+ reference input. Since only temperature monitor block comparators have a\r
selectable reference input, allowed values are:\r
- CMP1\r
- CMP3\r
- CMP7\r
- CMP9\r
- CMP11\r
- \r
+\r
@param reference\r
The reference parameter specify the signal that will be used as reference\r
by the comparator. Allowed values are:\r
The ACE_set_comp_hysteresis() function is used to set the hysteresis of a\r
comparator. There are four possible hystereris settings: no hysteresis,\r
+/-10mV, +/-30mV or +/-100mV.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies the comparator for which this function will\r
set the hyteresis.\r
- \r
+\r
@param hysteresis\r
- The hysteresis parameter specifies the hysteresis that will be applied to \r
+ The hysteresis parameter specifies the hysteresis that will be applied to\r
the comparator's input. Allowed values are:\r
- NO_HYSTERESIS\r
- HYSTERESIS_10_MV\r
- HYSTERESIS_30_MV\r
- HYSTERESIS_100_MV\r
- \r
+\r
*/\r
void ACE_set_comp_hysteresis\r
(\r
/*-------------------------------------------------------------------------*//**\r
The ACE_enable_comp() function is used to enable the comparator specified as\r
parameter.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be enabled by a call\r
to this function.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_disable_comp() function is used to disable the comparator specified as\r
parameter.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be disabled by a call\r
to this function.\r
- void ACE_Comp9_Rise_IRQHandler( void );\r
- void ACE_Comp10_Rise_IRQHandler( void );\r
- void ACE_Comp11_Rise_IRQHandler( void );\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be enabled to generate\r
rising interrupts.\r
The ACE_disable_comp_rise_irq() function is used to disable interrupts from\r
being generated when the positive input of the comparator specified as parameter\r
rises above the negative input of the comparator.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be disabled from\r
generating rising interrupts.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_clear_comp_rise_irq() function is used to clear rise interrupts. This\r
function is typically called as part of the rise interrupt service routine.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies the comparator for which to clear the rise\r
interrupt.\r
- \r
+\r
Example:\r
@code\r
void ACE_Comp1_Rise_IRQHandler( void )\r
- void ACE_Comp9_Fall_IRQHandler( void );\r
- void ACE_Comp10_Fall_IRQHandler( void );\r
- void ACE_Comp11_Fall_IRQHandler( void );\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be enabled to generate\r
fall interrupts.\r
The ACE_disable_comp_fall_irq() function is used to disable interrupts from\r
being generated when the positive input of the comparator specified as parameter\r
falls below the negative input of the comparator.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies which comparator will be disabled from\r
generating fall interrupts.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_clear_comp_fall_irq() function is used to clear fall interrupts. This\r
function is typically called as part of the fall interrupt service routine.\r
- \r
+\r
@param comp_id\r
The comp_id parameter specifies the comparator for which to clear the fall\r
interrupt.\r
- \r
+\r
Example:\r
@code\r
void ACE_Comp1_Fall_IRQHandler( void )\r
status. It returns a 32 bit value indicating which comparators experienced a\r
fall and/or rise event. These status bits can be cleared using the\r
ACE_clear_comp_rise_irq() and ACE_clear_comp_fall_irq() functions.\r
- \r
+\r
@return\r
The return value is a 32 bit numnber where bits 0 to 11 indicate which\r
comparator experienced a fall event and bits 21 to 23 indicate which\r
The ACE_is_hysteresis_flag() function indicates if an hysteresis is applied\r
to the analog input sample value when determining the state of the flag\r
identified as parameter.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@return\r
This function returns the value one if a hysteresis is applied to the channel\r
sample values as part of determining the state of the flag identified as\r
The ACE_is_under_flag() function indicates whether a flag is triggered when the\r
monitored analog input falls below the flag's threshold level or above the\r
flag's threshold level.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@return\r
This function returns the value one if the flag identified as parameter\r
triggers as a result of the monitored input falling below the flag's\r
over flag configured with a 100 millivolts hysteresis will result in the flag\r
being asserted when the voltage reaches 1.1 volts and deasserted when the\r
voltage falls below 0.9 volt.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@param new_threshold\r
The new_threshold parameter specifies the new threshold level that must be\r
reached in order for the flag to be raised. The value of this parameter is\r
the sample value resulting from a post processing engine conversion of the\r
desired analog input threshold level.\r
- \r
+\r
Example:\r
The function below sets the threshold of the flag specified as parameter to\r
1 volt.\r
{\r
uint16_t new_threshold;\r
ace_channel_handle_t channel_handle;\r
- \r
+\r
channel_handle = ACE_get_flag_channel(flag_handle);\r
new_threshold = ACE_convert_from_mV(channel_handle, 1000);\r
ACE_set_flag_threshold(flag_handle, new_threshold);\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@param adc_hysteresis\r
The adc_hysteresis parameter is the value to add and subtract to the\r
threshold value to obtain the hysteresis high and low limits triggering flag\r
configurator for one of the analog inputs and one of the flags associated\r
with that input.\r
The method used to compute the adc_hysteresis value will work for all\r
- input types including ABPS inputs where zero Volts is not equivalent to a \r
+ input types including ABPS inputs where zero Volts is not equivalent to a\r
PPE sample value of zero.\r
- \r
+\r
@code\r
ace_channel_handle_t channel_handle;\r
ace_flag_handle_t flag_handle;\r
uint16_t adc_hysteresis;\r
uint16_t upper_limit;\r
uint16_t lower_limit;\r
- \r
+\r
channel_handle = VoltageMonitor;\r
flag_handle = VoltageMonitor_OVER_1V;\r
- \r
+\r
upper_limit = ACE_convert_from_mV(channel_handle, 100);\r
lower_limit = ACE_convert_from_mV(channel_handle, 0);\r
- \r
+\r
if (upper_limit > lower_limit)\r
{\r
adc_hysteresis = upper_limit - lower_limit;\r
{\r
adc_hysteresis = lower_limit - upper_limit;\r
}\r
- \r
+\r
ACE_set_flag_hysteresis(flag_handle, adc_hysteresis);\r
@endcode\r
*/\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@param assertion_value\r
The assertion_value parameter is the Post Processing Engine sample value that\r
must be reached for the flag, identified through the flag_handle parameter,\r
intended to be used where the threshold value is not centered within the\r
hysteresis window. They allow specifying the actual threshold values at which\r
the flag will be asserted and deasserted.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@param assertion_value\r
The assertion_value parameter is the Post Processing Engine sample value\r
that must be reached for the flag, identified through the flag_handle\r
analog input channel sample values when generating flags. It sets the\r
hysteresis for all flags generated based on the value of the analog input\r
channel identified by the channel handle passed as first parameter.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in\r
/*-------------------------------------------------------------------------*//**\r
*\r
*/\r
- \r
+\r
/*==============================================================================\r
================================== Flags ======================================\r
=============================================================================*/\r
by the flag name passed as parameter. The flag handle obtained through this\r
function is then used as parameter to other flag control functions to identify\r
which flag is to be controlled by the called function.\r
- \r
+\r
@param p_sz_full_flag_name\r
The p_sz_full_flag_name parameter is a pointer to a zero-terminated string\r
holding the name of the flag as specified in the ACE configurator. The full\r
For example, the full name for the flag called "CriticalOver" raised when\r
the input channel called "MainSupply" reaches a critical level would be\r
named "MainSupply:CriticalOver".\r
- \r
+\r
@return\r
The ACE_get_flag_handle() returns the flag handle associated with the flag\r
name passed as parameter. It returns INVALID_FLAG_HANDLE when the flag name\r
The ACE_get_flag_status() function returns the current status of the flag\r
specified as parameter. The flag is identified through the name specified in\r
the ACE configurator when the flag was created.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@return\r
The ACE_get_flag_status() function returns one of the following values\r
depending on the current status of the flag:\r
sampled on the analog input channel identified as parameter are enabled to\r
generate interrupts by this function. It enables flag interrupts both at the\r
ACE PEE flag and Cortex-M3 interrupt controller levels.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
generating interrupts by this function. The interrupt is only disabled at the\r
ACE PPE flag level in order to avoid disabling other cahnnel's flag interrupts\r
which may happen to use the same ACE threshold interrupt line.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
sampled on the analog input channel identified as parameter are cleared by\r
this function. This function would typically be used before enabling the flag\r
interrupts in order to ignore past events.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
generated flags specified as parameter to interrupt the Cortex-M3 processor.\r
It enables flag interrupts both at the ACE PPE flag and Cortex-M3 interrupt\r
controller levels.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
generated flags from interrupting the Cortex-M3. The interrupt is only\r
disabled at the ACE PPE flag level in order to avoid disabling other flags\r
interrupts which may happen to use the same ACE threshold interrupt line.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
The ACE_clear_flag_irq() function clears the interrupt for the flag specified\r
as parameter. This function would typically be used before enabling the flag\r
interrupt in order to ignore past events.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
/*-------------------------------------------------------------------------*//**\r
The ACE_get_flag_name() function returns the name of the flag identified by\r
the flag handle passed as parameter.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@return\r
The ACE_get_flag_name() function returns a pointer to a zero-terminated\r
string containing the name of the flag identified by the flag handle passed\r
The ACE_get_flag_channel() function returns the handle of the channel\r
monitored in order to generate the flag identified by the flag handle passed\r
as parameter.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@return\r
The ACE_get_flag_channel() function returns a channel handle identifying the\r
analog input channel monitored by the flag passed as parameter.\r
associated with the input channel specified by the channel_handle parameter.\r
It indicates how many flags are generated based on the value of the specified\r
analog input channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
The ACE_get_channel_flag_count() function returns the total number of flags\r
that are generated based on the value of the specified analog input channel.\r
The ACE_get_channel_flag_count() function returns 0 if no input channels were\r
configured.\r
- \r
+\r
Example\r
@code\r
uint32_t inc;\r
uint16_t flag_iterator;\r
ace_flag_handle_t current_flag;\r
ace_channel_handle_t channel_handle;\r
- \r
+\r
nb_of_flags = ACE_get_channel_flag_count(channel_handle);\r
current_flag = ACE_get_channel_first_flag(channel_handle, &flag_iterator);\r
- \r
+\r
for (inc = 0; inc < nb_of_flags; ++inc)\r
{\r
current_flag = ACE_get_channel_next_flag(channel_handle, &flag_iterator);\r
pointed to by the second function parameter. The iterator can be used\r
subsequently as a parameter to the ACE_get_channel_next_flag() function to\r
iterate through all flags associated with the analog input channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param iterator\r
The iterator parameter is a pointer to a uint16_t iterator variable. The\r
value of the iterator variable will be set by the ACE_get_channel_first_flag()\r
functions so that it can be used in subsequent calls to\r
ACE_get_channel_next_flag() to keep track of the current location in the\r
list of flags associated with the analog input channel.\r
- \r
+\r
@return\r
The ACE_get_channel_first_flag() function returns a flag handle identifying\r
one of the flags generated based on the value of the analog input channel\r
identified by the channel_handle parameter. It returns INVALID_FLAG_HANDLE\r
if no flags are generated based on the analog input channel input or if the\r
channel handle is invalid.\r
- \r
+\r
Example\r
@code\r
uint32_t inc;\r
uint16_t flag_iterator;\r
ace_flag_handle_t current_flag;\r
ace_channel_handle_t channel_handle;\r
- \r
+\r
nb_of_flags = ACE_get_channel_flag_count(channel_handle);\r
current_flag = ACE_get_channel_first_flag(channel_handle, &flag_iterator);\r
- \r
+\r
for (inc = 0; inc < nb_of_flags; ++inc)\r
{\r
current_flag = ACE_get_channel_next_flag(channel_handle, &flag_iterator);\r
associated with the analog input channel identified by the channel handle\r
passed as parameter. The retrieved flag handle is the next one in the driver's\r
internal flag list based on the iterator parameter.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param iterator\r
The iterator parameter is a pointer to a uint16_t iterator variable. The value\r
of the iterator variable will be set by the ACE_get_channel_first_flag()\r
functions so that it can be used in subsequent calls to\r
ACE_get_channel_next_flag() to keep track of the current location in the list\r
of flags associated with the analog input channel.\r
- \r
+\r
Example\r
@code\r
uint32_t inc;\r
uint16_t flag_iterator;\r
ace_flag_handle_t current_flag;\r
ace_channel_handle_t channel_handle;\r
- \r
+\r
nb_of_flags = ACE_get_channel_flag_count(channel_handle);\r
current_flag = ACE_get_channel_first_flag(channel_handle, &flag_iterator);\r
- \r
+\r
for (inc = 0; inc < nb_of_flags; ++inc)\r
{\r
current_flag = ACE_get_channel_next_flag(channel_handle, &flag_iterator);\r
with the ACE driver and associated with a particular flag through the\r
ACE_register_flag_isr() function. The ACE driver will call the flag handler\r
function when the associated flag is raised.\r
- \r
+\r
Declaring and Implementing PPE Flag Handler Functions\r
PPE flag handler functions should follow the following prototype:\r
void my_flag_handler ( ace_flag_handle_t flag_handle );\r
The actual name of the PPE flag handler is unimportant. You can use any name of\r
- your choice for the PPE flag handler. \r
+ your choice for the PPE flag handler.\r
The flag_handle parameter passes the handle of the raised flag to the flag\r
handler function.\r
*/\r
The ACE_register_flag_isr() function is used to register a handler function\r
with the ACE driver. The registered function will be called by the ACE driver\r
when the associated flag is raised by the ACE post processing engine.\r
- \r
+\r
@param flag_handle\r
The flag_handle parameter identifies one of the flags generated based on the\r
value of an analog input channel. The available flag handle values can be\r
ACE_get_flag_handle() when the name of the flag is known, or by iterating\r
though all flags associated with an analog input channel using the\r
ACE_get_channel_first_flag() and ACE_get_channel_next_flag().\r
- \r
+\r
@param flag_isr\r
The flag_isr parameter is a pointer to a flag handler function with the\r
- following prototype: \r
- void handler_function_name(ace_flag_handle_t flag_handle) \r
+ following prototype:\r
+ void handler_function_name(ace_flag_handle_t flag_handle)\r
The flag handler function is called by the ACE driver as part of the relevant\r
post processing engine flag interrupt service routine. It does not need to\r
handle flag interrupt clearing as this is done by the ACE driver.\r
\r
- \r
+\r
@code\r
void my_critical_handler( void );\r
- \r
+\r
void system_init( void )\r
{\r
ace_flag_handle_t flag_handle;\r
- \r
+\r
flag_handle = ACE_get_flag_handle( "MainSupply:CriticalLevel" );\r
ACE_register_flag_isr( flag_handle, my_critical_handler );\r
ACE_enable_flag_irq( flag_handle );\r
}\r
- \r
+\r
void my_critical_handler( ace_flag_handle_t flag_handle )\r
{\r
panic( flag_handle );\r
}\r
- \r
+\r
@endcode\r
*/\r
void ACE_register_flag_isr\r
channel through the ACE_register_channel_flags_isr() function. The ACE driver\r
will call the channel flags handler function when one of the flags for the\r
associated ADC input channel is raised.\r
- \r
+\r
Declaring and Implementing PPE Channel Flag Handler Functions\r
PPE channel flag handler functions should follow the following prototype:\r
void my_channel_flag_handler ( ace_flag_handle_t flag_handle );\r
handler will be called by the ACE driver when one of the flag generated based\r
on the value of the analog input channel identified by the channel handle\r
passed as parameter is asserted.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param channel_flag_isr\r
The channel_flag_isr parameter is pointer to a function taking a flag handle\r
- as parameter. \r
- void handler_function_name(ace_flag_handle_t flag_handle) \r
+ as parameter.\r
+ void handler_function_name(ace_flag_handle_t flag_handle)\r
The flag handler function is called by the ACE driver as part of the relevant\r
post processing engine flag interrupt service routine. It does not need to\r
handle flag interrupt clearing as this is done by the ACE driver.\r
- \r
+\r
Example\r
The example below demonstrates the use of the ACE_register_channel_flags_isr()\r
function in a system where the ACE is configured to have an analog input\r
channels named "MainSupply" with one flag named "Critical" generated based\r
on the value of "MainSupply" channel. The names "MainSupply" and "Critical"\r
- were user selected in the ACE configurator. \r
+ were user selected in the ACE configurator.\r
@code\r
void main_supply_handler (ace_flag_handle_t flag_handle);\r
- \r
+\r
void system_init(void)\r
{\r
ACE_register_channel_flag_isr(MainSupply, main_supply_handler);\r
ACE_enable_channel_flags_irq(MainSupply);\r
}\r
- \r
+\r
void main_supply_handler (ace_flag_handle_t flag_handle)\r
{\r
if (MainSupply_Critical == flag_handle)\r
panic(flag_handle);\r
}\r
}\r
- \r
+\r
@endcode\r
*/\r
void ACE_register_channel_flags_isr\r
registered with the ACE driver through the ACE_register_global_flags_isr()\r
function. The ACE driver will call the global flags handler function when any\r
flag for any ADC input channel is raised.\r
- \r
+\r
Declaring and Implementing Global Flag Handler Functions\r
PPE global flag handler functions should follow the following prototype:\r
- void my_global_flag_handler( \r
- ace_flag_handle_t flag_handle, \r
- ace_channel_handle_t channel_handle \r
+ void my_global_flag_handler(\r
+ ace_flag_handle_t flag_handle,\r
+ ace_channel_handle_t channel_handle\r
);\r
The actual name of the PPE global flag handler is unimportant. You can use any\r
name of your choice for the PPE global flag handler. The flag_handle parameter\r
The ACE_register_global_flags_isr() function is used to register a global\r
flag handler function with the ACE driver. The registered global handler will\r
be called when any flag interrupt is generated.\r
- \r
+\r
@param global_flag_isr\r
The global_flag_isr parameter is a pointer to a function taking a flag\r
handle and channel handle as parameter.\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion.\r
- \r
+\r
@return\r
The ACE_convert_adc_input_to_mV() returns the number of millivolts derived\r
from the ADC sample value passed as parameter.\r
/*-------------------------------------------------------------------------*//**\r
The ACE_convert_to_mV() function converts a PPE sample value into milli-Volts.\r
It handles prescaling adjusments based on ACE configuration for ABPS inputs.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion.\r
- \r
+\r
@return\r
The ACE_convert_to_mV() returns the number of millivolts derived from the\r
PPE sample value passed as parameter. The returned value can be either\r
The ACE_convert_to_mA() function converts a PPE sample value into milli-Amps.\r
The result of the conversion is only meaningful if the PPE sample value\r
results from the conversion of a current monitor input.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion\r
of the voltage generated by a current monitor analog block.\r
- \r
+\r
@return\r
The ACE_convert_to_mA() returns the number of milliamps derived from the\r
PPE sample value passed as parameter.\r
The ACE_convert_to_Kelvin() function converts a PPE sample value into degrees\r
Kelvin. The result of the conversion is only meaningful if the PPE sample value\r
results from the conversion of a temperature monitor input.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion\r
of the voltage generated by a temperature monitor analog block.\r
- \r
+\r
@return\r
The ACE_convert_to_Kelvin() returns the number of degrees Kelvin derived\r
from the PPE sample value passed as parameter.\r
The ACE_convert_to_Celsius() function converts a PPE sample value into tenths\r
of degrees Celsius. The result of the conversion is only meaningful if the PPE\r
sample value results from the conversion of a temperature monitor input.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion\r
of the voltage generated by a temperature monitor analog block.\r
- \r
+\r
@return\r
The ACE_convert_to_Celsius() returns the number of tenths of degrees Celsius\r
derived from the PPE sample value passed as parameter.\r
The ACE_convert_to_Fahrenheit() function converts a PPE sample value into\r
degrees Fahrenheit. The result of the conversion is only meaningful if the PPE\r
sample value results from the conversion of a temperature monitor input.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param sample_value\r
The sample_value parameter is the result of an analog to digital conversion\r
of the voltage generated by a temperature monitor analog block.\r
- \r
+\r
@return\r
The ACE_convert_to_Fahrenheit() returns the number of degrees Fahrenheit\r
derived from the PPE sample value passed as parameter.\r
This function is intended for use when directly controlling the ADC, not when\r
using samples read from the PPE. It does not account for prescaling taking\r
place before the ADC hardware input.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param voltage\r
The voltage parameter is the milli-Volts voltage value for which we want this\r
function to return the associated ADC sample result value.\r
- \r
+\r
@return\r
The ACE_convert_mV_to_adc_value() returns the ADC sample value that would be\r
produced if the analog input channel identified by channel_handle was set to\r
voltage value on the analog input channel specified as parameter.\r
This function handles prescaling adjusments based on ACE configuration for\r
ABPS inputs.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param voltage\r
The voltage parameter is the milli-Volts voltage value for which we want this\r
function to return the associated PPE sample result value.\r
- \r
+\r
@return\r
The ACE_convert_from_mV() returns the PPE sample value that would be produced\r
if the analog input channel identified by channel_handle was set to the\r
current value on the analog input channel specified as parameter.\r
The result of the conversion is only meaningful if the analog input channel\r
specified as parameter is configured as a current monitoring channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param current\r
The current parameter is the milli-Amps current value for which we want this\r
function to return the associated PPE sample result value.\r
- \r
+\r
@return\r
The ACE_convert_from_mA() returns the PPE sample value that would be produced\r
if the analog input channel identified by channel_handle was set to the\r
temperature value on the analog input channel specified as parameter.\r
The result of the conversion is only meaningful if the analog input channel\r
specified as parameter is configured as a temperature monitoring channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param temperature\r
The temperature parameter is the degrees Kelvin temperature value for which\r
we want this function to return the associated PPE sample result value.\r
- \r
+\r
@return\r
The ACE_convert_from_Kelvin() returns the PPE sample value that would be\r
produced if the analog input channel identified by channel_handle was set to\r
temperature value on the analog input channel specified as parameter.\r
The result of the conversion is only meaningful if the analog input channel\r
specified as parameter is configured as a temperature monitoring channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param temperature\r
The temperature parameter is the degrees Celsius temperature value for which\r
we want this function to return the associated PPE sample result value.\r
- \r
+\r
@return\r
The ACE_convert_from_Celsius() returns the PPE sample value that would be\r
produced if the analog input channel identified by channel_handle was set to\r
this temperature value on the analog input channel specified as parameter.\r
The result of the conversion is only meaningful if the analog input channel\r
specified as parameter is configured as a temperature monitoring channel.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in the\r
ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param temperature\r
The temperature parameter is the degrees Fahrenheit temperature value for\r
which we want this function to return the associated PPE sample result value.\r
- \r
+\r
@return\r
The ACE_convert_from_Fahrenheit() returns the PPE sample value that would be\r
produced if the analog input channel identified by channel_handle was set to\r
The PDMA sampling values are obtained by configuring the PDMA controller to\r
transfer data from the ACE into a memory buffer. The ACE_translate_pdma_value()\r
function is used to interpret the content of that memory buffer.\r
- \r
+\r
Please note that the translation of PDMA data containing raw ADC values from\r
ABPS inputs will result in sample values with an unexpected polarity.\r
The returned sample value will have the opposite polarity to the actual analog\r
the analog front end that are normally hidden by the PPE processing of ADC raw\r
samples. The translation of raw ADC values from analog inputs other than ABPS\r
inputs will result in correct sample values.\r
- \r
+\r
@param pdma_value\r
The pdma_value parameter is a 32-bit value received from the ACE through a\r
- peripheral DMA transfer. \r
- \r
+ peripheral DMA transfer.\r
+\r
@param channel_id\r
The channel_id parameter is a pointer to an ADC channel ID variable. It is\r
used to return the ID of the ADC channel from which the PPE sample value\r
was generated from. This parameter can be set to zero if retrieving the\r
channel ID is not required.\r
- \r
+\r
@return\r
The ACE_translate_pdma_value() returns the PPE sample value extracted from\r
the PDMA sampling value.\r
- \r
+\r
Example:\r
@code\r
uint16_t ppe_value;\r
uint16_t pdma_value;\r
adc_channel_id_t channel_id;\r
ace_channel_handle_t channel_handle;\r
- \r
+\r
pdma_value = get_next_pdma_ace_sample();\r
ppe_value = ACE_translate_pdma_value(pdma_value, &channel_id);\r
channel_handle = ACE_get_input_channel_handle(channel_id);\r
display_value(channel_handle, ppe_value);\r
}\r
@endcode\r
- \r
+\r
*/\r
uint16_t ACE_translate_pdma_value\r
(\r
- ACE_get_default_c_offset()\r
- ACE_set_linear_transform()\r
The post processing engine performs a linear transform on analog input samples\r
- obtained from the sample sequencing engine. The main purpose of this linear \r
+ obtained from the sample sequencing engine. The main purpose of this linear\r
transform is to apply part specific factory calibration to the analog samples\r
in order to achieve high accuracy. A second user specified linear transform\r
can also be optionally applied to the analog samples. This second linear\r
factor of the user defined linear transform applied by the post processing\r
engine to analog samples. The user defined linear transform m factor default\r
value is selected in the ACE configurator tool.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in\r
to ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
The ACE_get_default_m_factor() function returns the user transform m factor\r
default value. It is a signed 16-bit number representing a factor in the\r
offset of the user defined linear transform applied by the post processing\r
engine to analog samples. The user defined linear transform c offset default\r
value is selected in the ACE configurator tool.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in\r
to ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@return\r
The ACE_get_default_c_offset() function returns the user linear transform\92s\r
c offset default value. It is a signed 16-bit number representing a factor\r
linear transform applied to analog input samples by the post processing\r
engine. The linear transform is of the form y = m.x + b where the m factor\r
and c offset are in the range -2 to +1.99993896484375.\r
- \r
+\r
@param channel_handle\r
The channel_handle parameter identifies one of the analog input channels\r
monitored by the ACE. The available channel handle values can be found in\r
to ACE_get_channel_handle() when the name of the channel is known, or by\r
iterating though all analog input channel using the ACE_get_first_channel()\r
and ACE_get_next_channel().\r
- \r
+\r
@param m2\r
The m2 parameter specifies the user defined transform\92s m factor. It is a\r
signed 16-bit number representing a factor in the range -2 to\r
+1.99993896484375. The value of the m2 factor is obtained by multiplying the\r
parameter\92s absolute value by 2^-14. For example, a value of 0x7000\r
represents a 1.75 factor and a value of 0xE000 represents a -0.5 factor.\r
- \r
+\r
@param c2\r
The c2 parameter specifies the user defined transform\92s c offset. It is a\r
signed 16-bit number representing an offset in the range -2 to\r
+1.99993896484375. The value of the c2 offset is obtained by multiplying the\r
parameter\92s absolute value by 2^-14. For example, a value of 0x1000 represents\r
a 0.25 offset and a value of 0xB000 represents a -1.25 offset.\r
- \r
+\r
@code\r
void reset_to_default(ace_channel_handle_t channel_handle)\r
{\r
int16_t m;\r
int16_t c;\r
- \r
+\r
m = ACE_get_default_m_factor(channel_handle);\r
c = ACE_get_default_c_offset(channel_handle);\r
ACE_set_linear_transform(channel_handle, m, c);\r
);\r
\r
/** @} */\r
- \r
+\r
#ifdef __cplusplus\r
}\r
#endif\r
projects / freertos / blobdiff