1 /**
2 * \file
3 *
4 * \brief I2C Slave Interrupt Driver for SAMB
5 *
6 * Copyright (C) 2015 Atmel Corporation. All rights reserved.
7 *
8 * \asf_license_start
9 *
10 * \page License
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 *
18 * 2. Redistributions in binary form must reproduce the above copyright notice,
19 * this list of conditions and the following disclaimer in the documentation
20 * and/or other materials provided with the distribution.
21 *
22 * 3. The name of Atmel may not be used to endorse or promote products derived
23 * from this software without specific prior written permission.
24 *
25 * 4. This software may only be redistributed and used in connection with an
26 * Atmel microcontroller product.
27 *
28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
39 *
40 * \asf_license_stop
41 *
42 */
43 /*
44 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45 */
46
47 #ifndef I2C_SLAVE_INTERRUPT_H_INCLUDED
48 #define I2C_SLAVE_INTERRUPT_H_INCLUDED
49
50 #include "i2c_slave.h"
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 /**
57 * \addtogroup asfdoc_samb_i2c_group
58 * @{
59 *
60 */
61
62 /**
63 * \name Callbacks
64 * @{
65 */
66 #if !defined(__DOXYGEN__)
67 extern void *_i2c_instances;
68 void _i2c_slave_rx_isr_handler(void);
69 void _i2c_slave_tx_isr_handler(void);
70 #endif
71
72 void i2c_slave_register_callback(
73 struct i2c_slave_module *const module,
74 i2c_slave_callback_t callback,
75 enum i2c_slave_callback callback_type);
76
77 void i2c_slave_unregister_callback(
78 struct i2c_slave_module *const module,
79 enum i2c_slave_callback callback_type);
80
81 /**
82 * \brief Enables callback
83 *
84 * Enables the callback specified by the callback_type.
85 *
86 * \param[in,out] module Pointer to the software module struct
87 * \param[in] callback_type Callback type to enable
88 */
i2c_slave_enable_callback(struct i2c_slave_module * const module,enum i2c_slave_callback callback_type)89 static inline void i2c_slave_enable_callback(
90 struct i2c_slave_module *const module,
91 enum i2c_slave_callback callback_type)
92 {
93 /* Sanity check */
94 Assert(module);
95 Assert(module->hw);
96
97 /* Mark callback as enabled */
98 module->enabled_callback |= (1 << callback_type);
99 }
100
101 /**
102 * \brief Disables callback
103 *
104 * Disables the callback specified by the callback_type.
105 *
106 * \param[in,out] module Pointer to the software module struct
107 * \param[in] callback_type Callback type to disable
108 */
i2c_slave_disable_callback(struct i2c_slave_module * const module,enum i2c_slave_callback callback_type)109 static inline void i2c_slave_disable_callback(
110 struct i2c_slave_module *const module,
111 enum i2c_slave_callback callback_type)
112 {
113 /* Sanity check */
114 Assert(module);
115 Assert(module->hw);
116
117 /* Mark callback as disabled */
118 module->enabled_callback &= ~(1 << callback_type);
119 }
120
121 /** @} */
122
123 /**
124 * \name Read and Write, Interrupt-Driven
125 * @{
126 */
127
128
129 enum status_code i2c_slave_read_packet_job(
130 struct i2c_slave_module *const module,
131 struct i2c_slave_packet *const packet);
132
133 enum status_code i2c_slave_write_packet_job(
134 struct i2c_slave_module *const module,
135 struct i2c_slave_packet *const packet);
136
137
138 /** @} */
139
140 /** @} */
141
142 #ifdef __cplusplus
143 }
144 #endif
145
146 #endif /* I2C_SLAVE_INTERRUPT_H_INCLUDED */
147