SPIRIT_Irq.h File Reference

Configuration and management of SPIRIT IRQs. More...

Go to the source code of this file.

Detailed Description

Configuration and management of SPIRIT IRQs.

Author:

VMA division - AMS

Version:

3.2.2

Date:

08-July-2015

On the Spirit side specific IRQs can be enabled by setting a specific bitmask. The Spirit libraries allow the user to do this in two different ways:

• The first enables the IRQs one by one, i.e. using an SPI transaction for each IRQ to enable.

  Example:

    SpiritIrqDeInit(NULL);                // this call is used to reset the IRQ mask registers
    SpiritIrq(RX_DATA_READY  , S_ENABLE);
    SpiritIrq(VALID_SYNC  , S_ENABLE);
    SpiritIrq(RX_TIMEOUT  , S_ENABLE);
  

• The second strategy is to set the IRQ bitfields structure. So, during the initialization the user has to fill the SpiritIrqs structure setting to one the single field related to the IRQ he wants to enable, and to zero the single field related to all the IRQs he wants to disable.

  Example:

    SpiritIrqs irqMask;
  
    ...
  
    SpiritIrqDeInit(&irqMask);                // this call is used to reset the IRQ mask registers
                                              // and to set to 0x00000000 the irq mask in order to disable
                                              // all IRQs (disabled by default on startup)
    irqMask.IRQ_RX_DATA_READY  = 1;
    irqMask.IRQ_VALID_SYNC  = 1;
    irqMask.IRQ_RX_TIMEOUT  = 1;
  
    ...
  

The most applications will require a Spirit IRQ notification on an microcontroller EXTI line. Then, the user can check which IRQ has been raised using two different ways.

On the ISR of the EXTI line phisically linked to the Spirit pin configured for IRQ:

• Check only one Spirit IRQ (because the Spirit IRQ status register automatically blanks itself after an SPI reading) into the ISR.

  Example:

    if(SpiritIrqCheckFlag(RX_DATA_READY ))
    {
            // do something...
    }
  

• Check more than one Spirit IRQ status by storing the entire IRQ status registers into a bitfields SpiritIrqs structure and then check the interested bits.

  Example:

    SpiritIrqGetStatus(&irqStatus);
  
    if(irqStatus.IRQ_RX_DATA_READY)
    {
            // do something...
    }
    if(irqStatus.IRQ_VALID_SYNC)
    {
           // do something...
    }
    if(irqStatus.RX_TIMEOUT)
    {
           // do something...
    }
  

Attention:

© COPYRIGHT(c) 2015 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file SPIRIT_Irq.h.