The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_SAMD21G18A/TOOLCHAIN_ARM_MICRO/usart_interrupt.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_SAMR21G18A/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/sercom/usart/usart_interrupt.h@111:4336505e4b1c
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Kojto | 111:4336505e4b1c | 1 | /** |
Kojto | 111:4336505e4b1c | 2 | * \file |
Kojto | 111:4336505e4b1c | 3 | * |
Kojto | 111:4336505e4b1c | 4 | * \brief SAM SERCOM USART Asynchronous Driver |
Kojto | 111:4336505e4b1c | 5 | * |
Kojto | 111:4336505e4b1c | 6 | * Copyright (C) 2012-2015 Atmel Corporation. All rights reserved. |
Kojto | 111:4336505e4b1c | 7 | * |
Kojto | 111:4336505e4b1c | 8 | * \asf_license_start |
Kojto | 111:4336505e4b1c | 9 | * |
Kojto | 111:4336505e4b1c | 10 | * \page License |
Kojto | 111:4336505e4b1c | 11 | * |
Kojto | 111:4336505e4b1c | 12 | * Redistribution and use in source and binary forms, with or without |
Kojto | 111:4336505e4b1c | 13 | * modification, are permitted provided that the following conditions are met: |
Kojto | 111:4336505e4b1c | 14 | * |
Kojto | 111:4336505e4b1c | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
Kojto | 111:4336505e4b1c | 16 | * this list of conditions and the following disclaimer. |
Kojto | 111:4336505e4b1c | 17 | * |
Kojto | 111:4336505e4b1c | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
Kojto | 111:4336505e4b1c | 19 | * this list of conditions and the following disclaimer in the documentation |
Kojto | 111:4336505e4b1c | 20 | * and/or other materials provided with the distribution. |
Kojto | 111:4336505e4b1c | 21 | * |
Kojto | 111:4336505e4b1c | 22 | * 3. The name of Atmel may not be used to endorse or promote products derived |
Kojto | 111:4336505e4b1c | 23 | * from this software without specific prior written permission. |
Kojto | 111:4336505e4b1c | 24 | * |
Kojto | 111:4336505e4b1c | 25 | * 4. This software may only be redistributed and used in connection with an |
Kojto | 111:4336505e4b1c | 26 | * Atmel microcontroller product. |
Kojto | 111:4336505e4b1c | 27 | * |
Kojto | 111:4336505e4b1c | 28 | * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED |
Kojto | 111:4336505e4b1c | 29 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
Kojto | 111:4336505e4b1c | 30 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE |
Kojto | 111:4336505e4b1c | 31 | * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR |
Kojto | 111:4336505e4b1c | 32 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
Kojto | 111:4336505e4b1c | 33 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
Kojto | 111:4336505e4b1c | 34 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
Kojto | 111:4336505e4b1c | 35 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
Kojto | 111:4336505e4b1c | 36 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
Kojto | 111:4336505e4b1c | 37 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
Kojto | 111:4336505e4b1c | 38 | * POSSIBILITY OF SUCH DAMAGE. |
Kojto | 111:4336505e4b1c | 39 | * |
Kojto | 111:4336505e4b1c | 40 | * \asf_license_stop |
Kojto | 111:4336505e4b1c | 41 | * |
Kojto | 111:4336505e4b1c | 42 | */ |
Kojto | 111:4336505e4b1c | 43 | /* |
Kojto | 111:4336505e4b1c | 44 | * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> |
Kojto | 111:4336505e4b1c | 45 | */ |
Kojto | 111:4336505e4b1c | 46 | #ifndef USART_INTERRUPT_H_INCLUDED |
Kojto | 111:4336505e4b1c | 47 | #define USART_INTERRUPT_H_INCLUDED |
Kojto | 111:4336505e4b1c | 48 | |
Kojto | 111:4336505e4b1c | 49 | #include "usart.h" |
Kojto | 111:4336505e4b1c | 50 | |
Kojto | 111:4336505e4b1c | 51 | #ifdef __cplusplus |
Kojto | 111:4336505e4b1c | 52 | extern "C" { |
Kojto | 111:4336505e4b1c | 53 | #endif |
Kojto | 111:4336505e4b1c | 54 | |
Kojto | 111:4336505e4b1c | 55 | #if !defined(__DOXYGEN__) |
Kojto | 111:4336505e4b1c | 56 | enum status_code _usart_write_buffer( |
Kojto | 111:4336505e4b1c | 57 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 58 | uint8_t *tx_data, |
Kojto | 111:4336505e4b1c | 59 | uint16_t length); |
Kojto | 111:4336505e4b1c | 60 | |
Kojto | 111:4336505e4b1c | 61 | enum status_code _usart_read_buffer( |
Kojto | 111:4336505e4b1c | 62 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 63 | uint8_t *rx_data, |
Kojto | 111:4336505e4b1c | 64 | uint16_t length); |
Kojto | 111:4336505e4b1c | 65 | |
Kojto | 111:4336505e4b1c | 66 | void _usart_interrupt_handler( |
Kojto | 111:4336505e4b1c | 67 | uint8_t instance); |
Kojto | 111:4336505e4b1c | 68 | #endif |
Kojto | 111:4336505e4b1c | 69 | |
Kojto | 111:4336505e4b1c | 70 | /** |
Kojto | 111:4336505e4b1c | 71 | * \addtogroup asfdoc_sam0_sercom_usart_group |
Kojto | 111:4336505e4b1c | 72 | * |
Kojto | 111:4336505e4b1c | 73 | * @{ |
Kojto | 111:4336505e4b1c | 74 | */ |
Kojto | 111:4336505e4b1c | 75 | |
Kojto | 111:4336505e4b1c | 76 | /** |
Kojto | 111:4336505e4b1c | 77 | * \name Callback Management |
Kojto | 111:4336505e4b1c | 78 | * @{ |
Kojto | 111:4336505e4b1c | 79 | */ |
Kojto | 111:4336505e4b1c | 80 | void usart_register_callback( |
Kojto | 111:4336505e4b1c | 81 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 82 | usart_callback_t callback_func, |
Kojto | 111:4336505e4b1c | 83 | enum usart_callback callback_type); |
Kojto | 111:4336505e4b1c | 84 | |
Kojto | 111:4336505e4b1c | 85 | void usart_unregister_callback( |
Kojto | 111:4336505e4b1c | 86 | struct usart_module *module, |
Kojto | 111:4336505e4b1c | 87 | enum usart_callback callback_type); |
Kojto | 111:4336505e4b1c | 88 | |
Kojto | 111:4336505e4b1c | 89 | /** |
Kojto | 111:4336505e4b1c | 90 | * \brief Enables callback |
Kojto | 111:4336505e4b1c | 91 | * |
Kojto | 111:4336505e4b1c | 92 | * Enables the callback function registered by the \ref usart_register_callback. |
Kojto | 111:4336505e4b1c | 93 | * The callback function will be called from the interrupt handler when the |
Kojto | 111:4336505e4b1c | 94 | * conditions for the callback type are met. |
Kojto | 111:4336505e4b1c | 95 | * |
Kojto | 111:4336505e4b1c | 96 | * \param[in] module Pointer to USART software instance struct |
Kojto | 111:4336505e4b1c | 97 | * \param[in] callback_type Callback type given by an enum |
Kojto | 111:4336505e4b1c | 98 | */ |
Kojto | 111:4336505e4b1c | 99 | static inline void usart_enable_callback( |
Kojto | 111:4336505e4b1c | 100 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 101 | enum usart_callback callback_type) |
Kojto | 111:4336505e4b1c | 102 | { |
Kojto | 111:4336505e4b1c | 103 | /* Sanity check arguments */ |
Kojto | 111:4336505e4b1c | 104 | Assert(module); |
Kojto | 111:4336505e4b1c | 105 | |
Kojto | 111:4336505e4b1c | 106 | /* Enable callback */ |
Kojto | 111:4336505e4b1c | 107 | module->callback_enable_mask |= (1 << callback_type); |
Kojto | 111:4336505e4b1c | 108 | |
Kojto | 111:4336505e4b1c | 109 | } |
Kojto | 111:4336505e4b1c | 110 | |
Kojto | 111:4336505e4b1c | 111 | /** |
Kojto | 111:4336505e4b1c | 112 | * \brief Disable callback |
Kojto | 111:4336505e4b1c | 113 | * |
Kojto | 111:4336505e4b1c | 114 | * Disables the callback function registered by the \ref usart_register_callback, |
Kojto | 111:4336505e4b1c | 115 | * and the callback will not be called from the interrupt routine. |
Kojto | 111:4336505e4b1c | 116 | * |
Kojto | 111:4336505e4b1c | 117 | * \param[in] module Pointer to USART software instance struct |
Kojto | 111:4336505e4b1c | 118 | * \param[in] callback_type Callback type given by an enum |
Kojto | 111:4336505e4b1c | 119 | */ |
Kojto | 111:4336505e4b1c | 120 | static inline void usart_disable_callback( |
Kojto | 111:4336505e4b1c | 121 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 122 | enum usart_callback callback_type) |
Kojto | 111:4336505e4b1c | 123 | { |
Kojto | 111:4336505e4b1c | 124 | /* Sanity check arguments */ |
Kojto | 111:4336505e4b1c | 125 | Assert(module); |
Kojto | 111:4336505e4b1c | 126 | |
Kojto | 111:4336505e4b1c | 127 | /* Disable callback */ |
Kojto | 111:4336505e4b1c | 128 | module->callback_enable_mask &= ~(1 << callback_type); |
Kojto | 111:4336505e4b1c | 129 | } |
Kojto | 111:4336505e4b1c | 130 | |
Kojto | 111:4336505e4b1c | 131 | /** |
Kojto | 111:4336505e4b1c | 132 | * @} |
Kojto | 111:4336505e4b1c | 133 | */ |
Kojto | 111:4336505e4b1c | 134 | |
Kojto | 111:4336505e4b1c | 135 | /** |
Kojto | 111:4336505e4b1c | 136 | * \name Writing and Reading |
Kojto | 111:4336505e4b1c | 137 | * @{ |
Kojto | 111:4336505e4b1c | 138 | */ |
Kojto | 111:4336505e4b1c | 139 | enum status_code usart_write_job( |
Kojto | 111:4336505e4b1c | 140 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 141 | const uint16_t *tx_data); |
Kojto | 111:4336505e4b1c | 142 | |
Kojto | 111:4336505e4b1c | 143 | enum status_code usart_read_job( |
Kojto | 111:4336505e4b1c | 144 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 145 | uint16_t *const rx_data); |
Kojto | 111:4336505e4b1c | 146 | |
Kojto | 111:4336505e4b1c | 147 | enum status_code usart_write_buffer_job( |
Kojto | 111:4336505e4b1c | 148 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 149 | uint8_t *tx_data, |
Kojto | 111:4336505e4b1c | 150 | uint16_t length); |
Kojto | 111:4336505e4b1c | 151 | |
Kojto | 111:4336505e4b1c | 152 | enum status_code usart_read_buffer_job( |
Kojto | 111:4336505e4b1c | 153 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 154 | uint8_t *rx_data, |
Kojto | 111:4336505e4b1c | 155 | uint16_t length); |
Kojto | 111:4336505e4b1c | 156 | |
Kojto | 111:4336505e4b1c | 157 | void usart_abort_job( |
Kojto | 111:4336505e4b1c | 158 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 159 | enum usart_transceiver_type transceiver_type); |
Kojto | 111:4336505e4b1c | 160 | |
Kojto | 111:4336505e4b1c | 161 | enum status_code usart_get_job_status( |
Kojto | 111:4336505e4b1c | 162 | struct usart_module *const module, |
Kojto | 111:4336505e4b1c | 163 | enum usart_transceiver_type transceiver_type); |
Kojto | 111:4336505e4b1c | 164 | /** |
Kojto | 111:4336505e4b1c | 165 | * @} |
Kojto | 111:4336505e4b1c | 166 | */ |
Kojto | 111:4336505e4b1c | 167 | |
Kojto | 111:4336505e4b1c | 168 | /** |
Kojto | 111:4336505e4b1c | 169 | * @} |
Kojto | 111:4336505e4b1c | 170 | */ |
Kojto | 111:4336505e4b1c | 171 | |
Kojto | 111:4336505e4b1c | 172 | #ifdef __cplusplus |
Kojto | 111:4336505e4b1c | 173 | } |
Kojto | 111:4336505e4b1c | 174 | #endif |
Kojto | 111:4336505e4b1c | 175 | |
Kojto | 111:4336505e4b1c | 176 | #endif /* USART_INTERRUPT_H_INCLUDED */ |
Kojto | 111:4336505e4b1c | 177 |