1 /**
2 * \file
3 *
4 * \brief I2C Master 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_MASTER_INTERRUPT_H_INCLUDED
48 #define I2C_MASTER_INTERRUPT_H_INCLUDED
49
50 #include "i2c_master.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_master_isr_handler(void);
69 #endif
70
71 void i2c_master_register_callback(
72 struct i2c_master_module *const module,
73 i2c_master_callback_t callback,
74 enum i2c_master_callback callback_type);
75
76 void i2c_master_unregister_callback(
77 struct i2c_master_module *const module,
78 enum i2c_master_callback callback_type);
79
80 /**
81 * \brief Enables callback
82 *
83 * Enables the callback specified by the callback_type.
84 *
85 * \param[in,out] module Pointer to the software module struct
86 * \param[in] callback_type Callback type to enable
87 */
i2c_master_enable_callback(struct i2c_master_module * const module,enum i2c_master_callback callback_type)88 static inline void i2c_master_enable_callback(
89 struct i2c_master_module *const module,
90 enum i2c_master_callback callback_type)
91 {
92 /* Sanity check. */
93 Assert(module);
94 Assert(module->hw);
95
96 /* Mark callback as enabled. */
97 module->enabled_callback |= (1 << callback_type);
98 }
99
100 /**
101 * \brief Disables callback
102 *
103 * Disables the callback specified by the callback_type.
104 *
105 * \param[in,out] module Pointer to the software module struct
106 * \param[in] callback_type Callback type to disable
107 */
i2c_master_disable_callback(struct i2c_master_module * const module,enum i2c_master_callback callback_type)108 static inline void i2c_master_disable_callback(
109 struct i2c_master_module *const module,
110 enum i2c_master_callback callback_type)
111 {
112 /* Sanity check. */
113 Assert(module);
114 Assert(module->hw);
115
116 /* Mark callback as disabled. */
117 module->enabled_callback &= ~(1 << callback_type);
118 }
119
120 /** @} */
121
122
123 /**
124 * \name Read and Write, Interrupt-Driven
125 * @{
126 */
127
128 enum status_code i2c_master_read_packet_job(
129 struct i2c_master_module *const module,
130 struct i2c_master_packet *const packet);
131
132 enum status_code i2c_master_read_packet_job_no_stop(
133 struct i2c_master_module *const module,
134 struct i2c_master_packet *const packet);
135
136 enum status_code i2c_master_write_packet_job(
137 struct i2c_master_module *const module,
138 struct i2c_master_packet *const packet);
139
140 enum status_code i2c_master_write_packet_job_no_stop(
141 struct i2c_master_module *const module,
142 struct i2c_master_packet *const packet);
143
144 /** @} */
145
146 /** @} */
147
148 #ifdef __cplusplus
149 }
150 #endif
151
152 #endif /* I2C_MASTER_INTERRUPT_H_INCLUDED */
153