LUFA/Common/Atomic.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Atomic block header for the 32-bit AVRs, modelled on the 8-bit AVR's util/atomic.h
  34  *  header.
  35  *
  36  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  37  *        functionality on the 32-bit AVRs.
  38  */
  39
  40 #ifndef __ATOMIC_H__
  41 #define __ATOMIC_H__
  42
  43         /* Includes: */
  44                 #include <avr32/io.h>
  45                 #include <stdint.h>
  46                 #include <stdbool.h>
  47
  48         /* Public Interface - May be used in end-application: */
  49                 /* Macros: */
  50                         #define ATOMIC_BLOCK(type) for ( type, __ToDo = __iCliRetVal(); \
  51                                                                            __ToDo ; __ToDo = 0 )
  52                         #define NONATOMIC_BLOCK(type) for ( type, __ToDo = __iSeiRetVal(); \
  53                                                                                   __ToDo ;  __ToDo = 0 )
  54                         #define ATOMIC_RESTORESTATE uint8_t sreg_save \
  55                                 __attribute__((__cleanup__(__iRestore))) = 0 /* TODO */
  56                         #define ATOMIC_FORCEON uint8_t sreg_save \
  57                                 __attribute__((__cleanup__(__iSeiParam))) = 0
  58                         #define NONATOMIC_RESTORESTATE uint8_t sreg_save \
  59                                 __attribute__((__cleanup__(__iRestore))) = 0 /* TODO */
  60                         #define NONATOMIC_FORCEOFF uint8_t sreg_save \
  61                                 __attribute__((__cleanup__(__iCliParam))) = 0
  62
  63         /* Private Interface - For use in library only: */
  64         #if !defined(__DOXYGEN__)
  65                 /* Inline Functions: */
  66                         static __inline__ uint8_t __iSeiRetVal(void)
  67                         {
  68                                 ((avr32_sr_t*)AVR32_SR_T)->gm = true;
  69                                 return 1;
  70                         }
  71
  72                         static __inline__ uint8_t __iCliRetVal(void)
  73                         {
  74                                 ((avr32_sr_t*)AVR32_SR_T)->gm = false;
  75                                 return 1;
  76                         }
  77
  78                         static __inline__ void __iSeiParam(const uint8_t *__s)
  79                         {
  80                                 ((avr32_sr_t*)AVR32_SR_T)->gm = true;
  81                                 __asm__ volatile ("" ::: "memory");
  82                                 (void)__s;
  83                         }
  84
  85                         static __inline__ void __iCliParam(const uint8_t *__s)
  86                         {
  87                                 ((avr32_sr_t*)AVR32_SR_T)->gm = false;
  88                                 __asm__ volatile ("" ::: "memory");
  89                                 (void)__s;
  90                         }
  91
  92                         static __inline__ void __iRestore(const uint8_t *__s)
  93                         {
  94                                 ((avr32_sr_t*)AVR32_SR_T)->gm = *__s;
  95                                 __asm__ volatile ("" ::: "memory");
  96                         }
  97         #endif
  98
  99 #endif