BA / SerialCom

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of OmniWheels by Gustav Atmel

mbed-os/targets/TARGET_Maxim/TARGET_MAX32630/mxc/owm.h@2:798925c9e4a8, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:55:34 2018 +0000
Revision:
2:798925c9e4a8
Parent:
1:9c5af431a1f1 
bluetooth

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gustavatmel 1:9c5af431a1f1 1 /**
gustavatmel 1:9c5af431a1f1 2 * @file
gustavatmel 1:9c5af431a1f1 3 * @brief Registers, Bit Masks and Bit Positions for the 1-Wire Master
gustavatmel 1:9c5af431a1f1 4 * peripheral module.
gustavatmel 1:9c5af431a1f1 5 */
gustavatmel 1:9c5af431a1f1 6 /* ****************************************************************************
gustavatmel 1:9c5af431a1f1 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
gustavatmel 1:9c5af431a1f1 8 *
gustavatmel 1:9c5af431a1f1 9 * Permission is hereby granted, free of charge, to any person obtaining a
gustavatmel 1:9c5af431a1f1 10 * copy of this software and associated documentation files (the "Software"),
gustavatmel 1:9c5af431a1f1 11 * to deal in the Software without restriction, including without limitation
gustavatmel 1:9c5af431a1f1 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
gustavatmel 1:9c5af431a1f1 13 * and/or sell copies of the Software, and to permit persons to whom the
gustavatmel 1:9c5af431a1f1 14 * Software is furnished to do so, subject to the following conditions:
gustavatmel 1:9c5af431a1f1 15 *
gustavatmel 1:9c5af431a1f1 16 * The above copyright notice and this permission notice shall be included
gustavatmel 1:9c5af431a1f1 17 * in all copies or substantial portions of the Software.
gustavatmel 1:9c5af431a1f1 18 *
gustavatmel 1:9c5af431a1f1 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
gustavatmel 1:9c5af431a1f1 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gustavatmel 1:9c5af431a1f1 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
gustavatmel 1:9c5af431a1f1 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
gustavatmel 1:9c5af431a1f1 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
gustavatmel 1:9c5af431a1f1 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
gustavatmel 1:9c5af431a1f1 25 * OTHER DEALINGS IN THE SOFTWARE.
gustavatmel 1:9c5af431a1f1 26 *
gustavatmel 1:9c5af431a1f1 27 * Except as contained in this notice, the name of Maxim Integrated
gustavatmel 1:9c5af431a1f1 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
gustavatmel 1:9c5af431a1f1 29 * Products, Inc. Branding Policy.
gustavatmel 1:9c5af431a1f1 30 *
gustavatmel 1:9c5af431a1f1 31 * The mere transfer of this software does not imply any licenses
gustavatmel 1:9c5af431a1f1 32 * of trade secrets, proprietary technology, copyrights, patents,
gustavatmel 1:9c5af431a1f1 33 * trademarks, maskwork rights, or any other form of intellectual
gustavatmel 1:9c5af431a1f1 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
gustavatmel 1:9c5af431a1f1 35 * ownership rights.
gustavatmel 1:9c5af431a1f1 36 *
gustavatmel 1:9c5af431a1f1 37 * $Date: 2016-03-14 10:08:53 -0500 (Mon, 14 Mar 2016) $
gustavatmel 1:9c5af431a1f1 38 * $Revision: 21855 $
gustavatmel 1:9c5af431a1f1 39 *
gustavatmel 1:9c5af431a1f1 40 **************************************************************************** */
gustavatmel 1:9c5af431a1f1 41
gustavatmel 1:9c5af431a1f1 42 /* Define to prevent redundant inclusion */
gustavatmel 1:9c5af431a1f1 43 #ifndef _OWM_H_
gustavatmel 1:9c5af431a1f1 44 #define _OWM_H_
gustavatmel 1:9c5af431a1f1 45
gustavatmel 1:9c5af431a1f1 46 /* **** Includes **** */
gustavatmel 1:9c5af431a1f1 47 #include "mxc_config.h"
gustavatmel 1:9c5af431a1f1 48 #include "mxc_sys.h"
gustavatmel 1:9c5af431a1f1 49 #include "owm_regs.h"
gustavatmel 1:9c5af431a1f1 50
gustavatmel 1:9c5af431a1f1 51 #ifdef __cplusplus
gustavatmel 1:9c5af431a1f1 52 extern "C" {
gustavatmel 1:9c5af431a1f1 53 #endif
gustavatmel 1:9c5af431a1f1 54
gustavatmel 1:9c5af431a1f1 55 /**
gustavatmel 1:9c5af431a1f1 56 * @ingroup periphlibs
gustavatmel 1:9c5af431a1f1 57 * @defgroup owm 1-Wire Master (OWM)
gustavatmel 1:9c5af431a1f1 58 * @{
gustavatmel 1:9c5af431a1f1 59 */
gustavatmel 1:9c5af431a1f1 60
gustavatmel 1:9c5af431a1f1 61 /* **** Definitions **** */
gustavatmel 1:9c5af431a1f1 62
gustavatmel 1:9c5af431a1f1 63 /**
gustavatmel 1:9c5af431a1f1 64 * Enumeration type for 1-Wire Overdrive Speed Options.
gustavatmel 1:9c5af431a1f1 65 */
gustavatmel 1:9c5af431a1f1 66 typedef enum {
gustavatmel 1:9c5af431a1f1 67 OWM_OVERDRIVE_UNUSED = MXC_V_OWM_CTRL_STAT_OD_SPEC_MODE_12US, /**< 12us Overdrive Speed Select. */
gustavatmel 1:9c5af431a1f1 68 OWM_OVERDRIVE_12US = MXC_V_OWM_CTRL_STAT_OD_SPEC_MODE_12US, /**< 12us Overdrive Speed Select. */
gustavatmel 1:9c5af431a1f1 69 OWM_OVERDRIVE_10US = MXC_V_OWM_CTRL_STAT_OD_SPEC_MODE_10US /**< 10us Overdrive Speed Select. */
gustavatmel 1:9c5af431a1f1 70 } owm_overdrive_t;
gustavatmel 1:9c5af431a1f1 71
gustavatmel 1:9c5af431a1f1 72 /**
gustavatmel 1:9c5af431a1f1 73 * Enumeration type for specifying options for 1-Wire external pullup mode.
gustavatmel 1:9c5af431a1f1 74 */
gustavatmel 1:9c5af431a1f1 75 typedef enum {
gustavatmel 1:9c5af431a1f1 76 OWM_EXT_PU_ACT_HIGH = 0, /**< Pullup pin is active high when enabled. */
gustavatmel 1:9c5af431a1f1 77 OWM_EXT_PU_ACT_LOW = 1, /**< Pullup pin is active low when enabled. */
gustavatmel 1:9c5af431a1f1 78 OWM_EXT_PU_UNUSED = 2, /**< Pullup pin is not used for an external pullup. */
gustavatmel 1:9c5af431a1f1 79 } owm_ext_pu_t;
gustavatmel 1:9c5af431a1f1 80
gustavatmel 1:9c5af431a1f1 81 /**
gustavatmel 1:9c5af431a1f1 82 * Structure type for 1-Wire Master configuration.
gustavatmel 1:9c5af431a1f1 83 */
gustavatmel 1:9c5af431a1f1 84 typedef struct {
gustavatmel 1:9c5af431a1f1 85 uint8_t int_pu_en; /**< 1 = internal pullup on. */
gustavatmel 1:9c5af431a1f1 86 owm_ext_pu_t ext_pu_mode; /**< See #owm_ext_pu_t. */
gustavatmel 1:9c5af431a1f1 87 uint8_t long_line_mode; /**< 1 = long line mode enable. */
gustavatmel 1:9c5af431a1f1 88 owm_overdrive_t overdrive_spec; /**< 0 = timeslot is 12us, 1 = timeslot is 10us. */
gustavatmel 1:9c5af431a1f1 89 } owm_cfg_t;
gustavatmel 1:9c5af431a1f1 90
gustavatmel 1:9c5af431a1f1 91
gustavatmel 1:9c5af431a1f1 92 #define READ_ROM_COMMAND 0x33 /**< Read ROM Command */
gustavatmel 1:9c5af431a1f1 93 #define MATCH_ROM_COMMAND 0x55 /**< Match ROM Command */
gustavatmel 1:9c5af431a1f1 94 #define SEARCH_ROM_COMMAND 0xF0 /**< Search ROM Command */
gustavatmel 1:9c5af431a1f1 95 #define SKIP_ROM_COMMAND 0xCC /**< Skip ROM Command */
gustavatmel 1:9c5af431a1f1 96 #define OD_SKIP_ROM_COMMAND 0x3C /**< Overdrive Skip ROM Command */
gustavatmel 1:9c5af431a1f1 97 #define OD_MATCH_ROM_COMMAND 0x69 /**< Overdrive Match ROM Command */
gustavatmel 1:9c5af431a1f1 98 #define RESUME_COMMAND 0xA5 /**< Resume Command */
gustavatmel 1:9c5af431a1f1 99
gustavatmel 1:9c5af431a1f1 100 /* **** Globals **** */
gustavatmel 1:9c5af431a1f1 101
gustavatmel 1:9c5af431a1f1 102 /* **** Function Prototypes **** */
gustavatmel 1:9c5af431a1f1 103
gustavatmel 1:9c5af431a1f1 104 /**
gustavatmel 1:9c5af431a1f1 105 * @brief Initialize and enable OWM module.
gustavatmel 1:9c5af431a1f1 106 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 107 * @param cfg Pointer to OWM configuration.
gustavatmel 1:9c5af431a1f1 108 * @param sys_cfg Pointer to system configuration object
gustavatmel 1:9c5af431a1f1 109 *
gustavatmel 1:9c5af431a1f1 110 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 111 * @retval #E_NULL_PTR if parameter is a null pointer
gustavatmel 1:9c5af431a1f1 112 * @retval #E_BUSY if IOMAN was not configured correctly
gustavatmel 1:9c5af431a1f1 113 * @retval #E_UNINITIALIZED if OWM CLK disabled
gustavatmel 1:9c5af431a1f1 114 * @retval #E_NOT_SUPPORTED if 1MHz CLK cannot be created with given system and owm CLK
gustavatmel 1:9c5af431a1f1 115 * @retval #E_BAD_PARAM if bad cfg parameter passed in
gustavatmel 1:9c5af431a1f1 116 */
gustavatmel 1:9c5af431a1f1 117 int OWM_Init(mxc_owm_regs_t *owm, const owm_cfg_t *cfg, const sys_cfg_owm_t *sys_cfg);
gustavatmel 1:9c5af431a1f1 118
gustavatmel 1:9c5af431a1f1 119 /**
gustavatmel 1:9c5af431a1f1 120 * @brief Shutdown OWM module.
gustavatmel 1:9c5af431a1f1 121 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 122 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 123 * @retval #E_BUSY if IOMAN was not released
gustavatmel 1:9c5af431a1f1 124 */
gustavatmel 1:9c5af431a1f1 125 int OWM_Shutdown(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 126
gustavatmel 1:9c5af431a1f1 127 /**
gustavatmel 1:9c5af431a1f1 128 * @brief Send 1-Wire reset pulse. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 129 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 130 * @retval (0) = no presence pulse detected, (1) = presence pulse detected
gustavatmel 1:9c5af431a1f1 131 */
gustavatmel 1:9c5af431a1f1 132 int OWM_Reset(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 133
gustavatmel 1:9c5af431a1f1 134 /**
gustavatmel 1:9c5af431a1f1 135 * @brief Send and receive one byte of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 136 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 137 * @param data data to send
gustavatmel 1:9c5af431a1f1 138 * @retval data read (1 byte)
gustavatmel 1:9c5af431a1f1 139 */
gustavatmel 1:9c5af431a1f1 140 int OWM_TouchByte(mxc_owm_regs_t *owm, uint8_t data);
gustavatmel 1:9c5af431a1f1 141
gustavatmel 1:9c5af431a1f1 142 /**
gustavatmel 1:9c5af431a1f1 143 * @brief Write one byte of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 144 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 145 * @param data data to send
gustavatmel 1:9c5af431a1f1 146 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 147 * @retval #E_COMM_ERR if data written != data parameter
gustavatmel 1:9c5af431a1f1 148 */
gustavatmel 1:9c5af431a1f1 149 int OWM_WriteByte(mxc_owm_regs_t *owm, uint8_t data);
gustavatmel 1:9c5af431a1f1 150
gustavatmel 1:9c5af431a1f1 151 /**
gustavatmel 1:9c5af431a1f1 152 * @brief Read one byte of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 153 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 154 * @retval data read (1 byte)
gustavatmel 1:9c5af431a1f1 155 */
gustavatmel 1:9c5af431a1f1 156 int OWM_ReadByte(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 157
gustavatmel 1:9c5af431a1f1 158 /**
gustavatmel 1:9c5af431a1f1 159 * @brief Send and receive one bit of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 160 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 161 * @param bit bit to send
gustavatmel 1:9c5af431a1f1 162 * @retval bit read
gustavatmel 1:9c5af431a1f1 163 */
gustavatmel 1:9c5af431a1f1 164 int OWM_TouchBit(mxc_owm_regs_t *owm, uint8_t bit);
gustavatmel 1:9c5af431a1f1 165
gustavatmel 1:9c5af431a1f1 166 /**
gustavatmel 1:9c5af431a1f1 167 * @brief Write one bit of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 168 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 169 * @param bit bit to send
gustavatmel 1:9c5af431a1f1 170 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 171 * @retval #E_COMM_ERR if bit written != bit parameter
gustavatmel 1:9c5af431a1f1 172 */
gustavatmel 1:9c5af431a1f1 173 int OWM_WriteBit(mxc_owm_regs_t *owm, uint8_t bit);
gustavatmel 1:9c5af431a1f1 174
gustavatmel 1:9c5af431a1f1 175 /**
gustavatmel 1:9c5af431a1f1 176 * @brief Read one bit of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 177 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 178 * @retval bit read
gustavatmel 1:9c5af431a1f1 179 */
gustavatmel 1:9c5af431a1f1 180 int OWM_ReadBit(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 181
gustavatmel 1:9c5af431a1f1 182 /**
gustavatmel 1:9c5af431a1f1 183 * @brief Write multiple bytes of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 184 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 185 * @param data Pointer to buffer for write data.
gustavatmel 1:9c5af431a1f1 186 * @param len Number of bytes to write.
gustavatmel 1:9c5af431a1f1 187 *
gustavatmel 1:9c5af431a1f1 188 * @retval Number of bytes written if successful
gustavatmel 1:9c5af431a1f1 189 * @retval #E_COMM_ERR if line short detected before transaction
gustavatmel 1:9c5af431a1f1 190 */
gustavatmel 1:9c5af431a1f1 191 int OWM_Write(mxc_owm_regs_t *owm, uint8_t* data, int len);
gustavatmel 1:9c5af431a1f1 192
gustavatmel 1:9c5af431a1f1 193 /**
gustavatmel 1:9c5af431a1f1 194 * @brief Read multiple bytes of data. Will block until transaction is complete.
gustavatmel 1:9c5af431a1f1 195 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 196 * @param data Pointer to buffer for read data.
gustavatmel 1:9c5af431a1f1 197 * @param len Number of bytes to read.
gustavatmel 1:9c5af431a1f1 198 *
gustavatmel 1:9c5af431a1f1 199 * @retval Number of bytes read if successful
gustavatmel 1:9c5af431a1f1 200 * @retval #E_COMM_ERR if line short detected before transaction
gustavatmel 1:9c5af431a1f1 201 */
gustavatmel 1:9c5af431a1f1 202 int OWM_Read(mxc_owm_regs_t *owm, uint8_t* data, int len);
gustavatmel 1:9c5af431a1f1 203
gustavatmel 1:9c5af431a1f1 204 /**
gustavatmel 1:9c5af431a1f1 205 * @brief Starts 1-Wire communication with Read ROM command
gustavatmel 1:9c5af431a1f1 206 * @note Only use the Read ROM command with one slave on the bus
gustavatmel 1:9c5af431a1f1 207 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 208 * @param ROMCode Pointer to buffer for ROM code read
gustavatmel 1:9c5af431a1f1 209 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 210 * @retval #E_COMM_ERR if reset, read or write fails
gustavatmel 1:9c5af431a1f1 211 */
gustavatmel 1:9c5af431a1f1 212 int OWM_ReadROM(mxc_owm_regs_t *owm, uint8_t* ROMCode);
gustavatmel 1:9c5af431a1f1 213
gustavatmel 1:9c5af431a1f1 214 /**
gustavatmel 1:9c5af431a1f1 215 * @brief Starts 1-Wire communication with Match ROM command
gustavatmel 1:9c5af431a1f1 216 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 217 * @param ROMCode Pointer to buffer with ROM code to match
gustavatmel 1:9c5af431a1f1 218 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 219 * @retval #E_COMM_ERR if reset or write fails
gustavatmel 1:9c5af431a1f1 220 */
gustavatmel 1:9c5af431a1f1 221 int OWM_MatchROM(mxc_owm_regs_t *owm, uint8_t* ROMCode);
gustavatmel 1:9c5af431a1f1 222
gustavatmel 1:9c5af431a1f1 223 /**
gustavatmel 1:9c5af431a1f1 224 * @brief Starts 1-Wire communication with Overdrive Match ROM command
gustavatmel 1:9c5af431a1f1 225 * @note After Overdrive Match ROM command is sent, the OWM is set to
gustavatmel 1:9c5af431a1f1 226 * overdrive speed. To set back to standard speed use OWM_SetOverdrive.
gustavatmel 1:9c5af431a1f1 227 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 228 * @param ROMCode Pointer to buffer with ROM code to match
gustavatmel 1:9c5af431a1f1 229 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 230 * @retval #E_COMM_ERR if reset or write fails
gustavatmel 1:9c5af431a1f1 231 */
gustavatmel 1:9c5af431a1f1 232 int OWM_ODMatchROM(mxc_owm_regs_t *owm, uint8_t* ROMCode);
gustavatmel 1:9c5af431a1f1 233
gustavatmel 1:9c5af431a1f1 234 /**
gustavatmel 1:9c5af431a1f1 235 * @brief Starts 1-Wire communication with Skip ROM command
gustavatmel 1:9c5af431a1f1 236 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 237 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 238 * @retval #E_COMM_ERR if reset or write fails
gustavatmel 1:9c5af431a1f1 239 */
gustavatmel 1:9c5af431a1f1 240 int OWM_SkipROM(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 241
gustavatmel 1:9c5af431a1f1 242 /**
gustavatmel 1:9c5af431a1f1 243 * @brief Starts 1-Wire communication with Overdrive Skip ROM command
gustavatmel 1:9c5af431a1f1 244 * @note After Overdrive Skip ROM command is sent, the OWM is set to
gustavatmel 1:9c5af431a1f1 245 * overdrive speed. To set back to standard speed use OWM_SetOverdrive
gustavatmel 1:9c5af431a1f1 246 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 247 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 248 * @retval #E_COMM_ERR if reset or write fails
gustavatmel 1:9c5af431a1f1 249 */
gustavatmel 1:9c5af431a1f1 250 int OWM_ODSkipROM(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 251
gustavatmel 1:9c5af431a1f1 252 /**
gustavatmel 1:9c5af431a1f1 253 * @brief Starts 1-Wire communication with Resume command
gustavatmel 1:9c5af431a1f1 254 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 255 * @retval #E_NO_ERROR if everything is successful
gustavatmel 1:9c5af431a1f1 256 * @retval #E_COMM_ERR if reset or write fails
gustavatmel 1:9c5af431a1f1 257 */
gustavatmel 1:9c5af431a1f1 258 int OWM_Resume(mxc_owm_regs_t *owm);
gustavatmel 1:9c5af431a1f1 259
gustavatmel 1:9c5af431a1f1 260 /**
gustavatmel 1:9c5af431a1f1 261 * @brief Starts 1-Wire communication with Search ROM command
gustavatmel 1:9c5af431a1f1 262 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 263 * @param newSearch (1) = start new search, (0) = continue search for next ROM
gustavatmel 1:9c5af431a1f1 264 * @param ROMCode Pointer to buffer with ROM code found
gustavatmel 1:9c5af431a1f1 265 * @retval (1) = ROM found, (0) = no new ROM found, end of search
gustavatmel 1:9c5af431a1f1 266 */
gustavatmel 1:9c5af431a1f1 267 int OWM_SearchROM(mxc_owm_regs_t *owm, int newSearch, uint8_t* ROMCode);
gustavatmel 1:9c5af431a1f1 268
gustavatmel 1:9c5af431a1f1 269 /**
gustavatmel 1:9c5af431a1f1 270 * @brief Clear interrupt flags.
gustavatmel 1:9c5af431a1f1 271 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 272 * @param mask Mask of interrupts to clear.
gustavatmel 1:9c5af431a1f1 273 */
gustavatmel 1:9c5af431a1f1 274 __STATIC_INLINE void OWM_ClearFlags(mxc_owm_regs_t *owm, uint32_t mask)
gustavatmel 1:9c5af431a1f1 275 {
gustavatmel 1:9c5af431a1f1 276 owm->intfl = mask;
gustavatmel 1:9c5af431a1f1 277 }
gustavatmel 1:9c5af431a1f1 278
gustavatmel 1:9c5af431a1f1 279 /**
gustavatmel 1:9c5af431a1f1 280 * @brief Get interrupt flags.
gustavatmel 1:9c5af431a1f1 281 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 282 * @retval Mask of active flags.
gustavatmel 1:9c5af431a1f1 283 */
gustavatmel 1:9c5af431a1f1 284 __STATIC_INLINE unsigned OWM_GetFlags(mxc_owm_regs_t *owm)
gustavatmel 1:9c5af431a1f1 285 {
gustavatmel 1:9c5af431a1f1 286 return (owm->intfl);
gustavatmel 1:9c5af431a1f1 287 }
gustavatmel 1:9c5af431a1f1 288
gustavatmel 1:9c5af431a1f1 289 /**
gustavatmel 1:9c5af431a1f1 290 * @brief Enables/Disables the External pullup
gustavatmel 1:9c5af431a1f1 291 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 292 * @param enable (1) = enable, (0) = disable
gustavatmel 1:9c5af431a1f1 293 */
gustavatmel 1:9c5af431a1f1 294 __STATIC_INLINE void OWM_SetExtPullup(mxc_owm_regs_t *owm, int enable)
gustavatmel 1:9c5af431a1f1 295 {
gustavatmel 1:9c5af431a1f1 296 if(enable)
gustavatmel 1:9c5af431a1f1 297 owm->cfg |= MXC_F_OWM_CFG_EXT_PULLUP_ENABLE;
gustavatmel 1:9c5af431a1f1 298 else
gustavatmel 1:9c5af431a1f1 299 owm->cfg &= ~(MXC_F_OWM_CFG_EXT_PULLUP_ENABLE);
gustavatmel 1:9c5af431a1f1 300 }
gustavatmel 1:9c5af431a1f1 301
gustavatmel 1:9c5af431a1f1 302 /**
gustavatmel 1:9c5af431a1f1 303 * @brief Enables/Disables Overdrive speed
gustavatmel 1:9c5af431a1f1 304 * @param owm Pointer to OWM regs.
gustavatmel 1:9c5af431a1f1 305 * @param enable (1) = overdrive, (0) = standard
gustavatmel 1:9c5af431a1f1 306 */
gustavatmel 1:9c5af431a1f1 307 __STATIC_INLINE void OWM_SetOverdrive(mxc_owm_regs_t *owm, int enable)
gustavatmel 1:9c5af431a1f1 308 {
gustavatmel 1:9c5af431a1f1 309 if(enable)
gustavatmel 1:9c5af431a1f1 310 owm->cfg |= MXC_F_OWM_CFG_OVERDRIVE;
gustavatmel 1:9c5af431a1f1 311 else
gustavatmel 1:9c5af431a1f1 312 owm->cfg &= ~(MXC_F_OWM_CFG_OVERDRIVE);
gustavatmel 1:9c5af431a1f1 313 }
gustavatmel 1:9c5af431a1f1 314
gustavatmel 1:9c5af431a1f1 315 /**@} end of group owm */
gustavatmel 1:9c5af431a1f1 316 #ifdef __cplusplus
gustavatmel 1:9c5af431a1f1 317 }
gustavatmel 1:9c5af431a1f1 318 #endif
gustavatmel 1:9c5af431a1f1 319
gustavatmel 1:9c5af431a1f1 320 #endif /* _OWM_H_ */