mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/sercom/usart/usart_interrupt.h@579:53297373a894, 2015-07-01 (annotated)

Committer:
mbed_official
Date:
Wed Jul 01 09:45:11 2015 +0100
Revision:
579:53297373a894
Child:
592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081



Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/



Initial version of drivers for SAMR21

Who changed what in which revision?

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