1 /**
2 *
3 * \file
4 *
5 * \brief SAM Frequency Meter driver.
6 *
7 * This file defines a useful set of functions for the FREQM on SAM devices.
8 *
9 * Copyright (c) 2015-2016 Atmel Corporation. All rights reserved.
10 *
11 * \asf_license_start
12 *
13 * \page License
14 *
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions are met:
17 *
18 * 1. Redistributions of source code must retain the above copyright notice,
19 * this list of conditions and the following disclaimer.
20 *
21 * 2. Redistributions in binary form must reproduce the above copyright notice,
22 * this list of conditions and the following disclaimer in the documentation
23 * and/or other materials provided with the distribution.
24 *
25 * 3. The name of Atmel may not be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * 4. This software may only be redistributed and used in connection with an
29 * Atmel microcontroller product.
30 *
31 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
34 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
35 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
40 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
42 *
43 * \asf_license_stop
44 *
45 */
46 /*
47 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
48 */
49
50 #include "freqm.h"
51 #include "freqm_callback.h"
52
53 /** \internal Max number of callback type. */
54 #define FREQM_CALLBACK_TYPE_NUM 1
55
56 struct freqm_module *_freqm_instance;
57
58
59 /**
60 * \brief Registers a callback
61 *
62 * Registers a callback function which is implemented by the user.
63 *
64 * \note The callback must be enabled by \ref freqm_enable_callback,
65 * in order for the interrupt handler to call it when the conditions for the
66 * callback type is met.
67 *
68 * \param[in] module Pointer to FREQM software instance struct
69 * \param[in] callback_func Pointer to callback function
70 * \param[in] callback_type Callback type given by an enum
71 *
72 * \retval STATUS_OK The function exited successfully
73 */
freqm_register_callback(struct freqm_module * const module,freqm_callback_t callback_func,enum freqm_callback callback_type)74 enum status_code freqm_register_callback(
75 struct freqm_module *const module,
76 freqm_callback_t callback_func,
77 enum freqm_callback callback_type)
78 {
79 /* Sanity check arguments */
80 Assert(module);
81 Assert(callback_func);
82
83 if (callback_type >= FREQM_CALLBACK_TYPE_NUM) {
84 Assert(false);
85 return STATUS_ERR_INVALID_ARG;
86 }
87 /* Register callback function */
88 module->callback[callback_type] = callback_func;
89
90 return STATUS_OK;
91 }
92
93 /**
94 * \brief Unregisters a callback
95 *
96 * Unregisters a callback function implemented by the user. The callback should be
97 * disabled before it is unregistered.
98 *
99 * \param[in] module Pointer to FREQM software instance struct
100 * \param[in] callback_type Callback type given by an enum
101 *
102 * \retval STATUS_OK The function exited successfully
103 */
freqm_unregister_callback(struct freqm_module * module,enum freqm_callback callback_type)104 enum status_code freqm_unregister_callback(
105 struct freqm_module *module,
106 enum freqm_callback callback_type)
107 {
108 /* Sanity check arguments */
109 Assert(module);
110
111 if (callback_type >= FREQM_CALLBACK_TYPE_NUM) {
112 Assert(false);
113 return STATUS_ERR_INVALID_ARG;
114 }
115 /* Unregister callback function */
116 module->callback[callback_type] = NULL;
117
118 return STATUS_OK;
119 }
120
121
122
123 /**
124 * \internal The FREQM interrupt handler.
125 */
FREQM_Handler(void)126 void FREQM_Handler(void)
127 {
128 /* Get device instance from the look-up table */
129 struct freqm_module *module = _freqm_instance;
130
131 /* Read and mask interrupt flag register */
132 uint32_t status = FREQM->INTFLAG.reg;
133
134 /* Check if data ready needs to be serviced */
135 if (status & FREQM_INTFLAG_DONE) {
136 if (module->callback[FREQM_CALLBACK_MEASURE_DONE]) {
137 FREQM->INTFLAG.reg = FREQM_INTFLAG_DONE;
138 module->callback[FREQM_CALLBACK_MEASURE_DONE]();
139 }
140 }
141
142 }
143