git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A5_SAMA5D2x_Xplained_IAR/AtmelFiles/utils/async.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2015, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 /**\r
  31  * \file\r
  32  *\r
  33  * Provide a routine for asynchronous transfer.\r
  34  *\r
  35  */\r
  36 \r
  37 #ifndef _ASYNC_\r
  38 #define _ASYNC_\r
  39 \r
  40 /*----------------------------------------------------------------------------\r
  41  *        Headers\r
  42  *----------------------------------------------------------------------------*/\r
  43 #include <stdint.h>\r
  44 \r
  45 /*----------------------------------------------------------------------------\r
  46  *        Definition\r
  47  *----------------------------------------------------------------------------*/\r
  48 /** Transfer is still pending.*/\r
  49 #define ASYNC_STATUS_PENDING        0xFF\r
  50 \r
  51 #ifdef __cplusplus\r
  52 extern "C" {\r
  53 #endif\r
  54 \r
  55 /*----------------------------------------------------------------------------\r
  56  *        Type\r
  57  *----------------------------------------------------------------------------*/\r
  58 /** \brief Asynchronous transfer descriptor. */\r
  59 struct _async {\r
  60         /** Asynchronous transfer status.*/\r
  61         volatile uint32_t status;\r
  62         /** Callback function to invoke when transfer completes or fails.*/\r
  63         void *callback;\r
  64         /** Driver storage area; do not use.*/\r
  65         uint8_t pStorage[12];\r
  66 } ;\r
  67 \r
  68 /*----------------------------------------------------------------------------\r
  69  *        Global functions\r
  70  *----------------------------------------------------------------------------*/\r
  71 extern uint32_t async_is_finished(struct _async * pAsync);\r
  72 \r
  73 #ifdef __cplusplus\r
  74 }\r
  75 #endif\r
  76 #endif                          /* #ifndef _ASYNC_ */\r