owm.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_OWM_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_OWM_H_
 
/* **** Includes **** */
#include "mxc_device.h"
#include "mxc_sys.h"
#include "owm_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* **** Definitions **** */
 
typedef enum {
    MXC_OWM_EXT_PU_ACT_HIGH = 0, 
    MXC_OWM_EXT_PU_ACT_LOW = 1, 
    MXC_OWM_EXT_PU_UNUSED = 2, 
} mxc_owm_ext_pu_t;
 
typedef struct {
    uint8_t int_pu_en; 
    mxc_owm_ext_pu_t ext_pu_mode; 
    uint8_t long_line_mode; 
    // mxc_owm_overdrive_t overdrive_spec; /**< 0 = timeslot is 12us, 1 = timeslot is 10us.   */
} mxc_owm_cfg_t;
 
#define READ_ROM_COMMAND 0x33 
#define MATCH_ROM_COMMAND 0x55 
#define SEARCH_ROM_COMMAND 0xF0 
#define SKIP_ROM_COMMAND 0xCC 
#define OD_SKIP_ROM_COMMAND 0x3C 
#define OD_MATCH_ROM_COMMAND 0x69 
#define RESUME_COMMAND 0xA5 
/* **** Globals **** */
 
/* **** Function Prototypes **** */
 
int MXC_OWM_Init(const mxc_owm_cfg_t *cfg);
 
void MXC_OWM_Shutdown(void);
 
int MXC_OWM_Reset(void);
 
int MXC_OWM_GetPresenceDetect(void);
 
int MXC_OWM_TouchByte(uint8_t data);
 
int MXC_OWM_WriteByte(uint8_t data);
 
int MXC_OWM_ReadByte(void);
 
int MXC_OWM_TouchBit(uint8_t bit);
 
int MXC_OWM_WriteBit(uint8_t bit);
 
int MXC_OWM_ReadBit(void);
 
int MXC_OWM_Write(uint8_t *data, int len);
 
int MXC_OWM_Read(uint8_t *data, int len);
 
int MXC_OWM_ReadROM(uint8_t *ROMCode);
 
int MXC_OWM_MatchROM(uint8_t *ROMCode);
 
int MXC_OWM_ODMatchROM(uint8_t *ROMCode);
 
int MXC_OWM_SkipROM(void);
 
int MXC_OWM_ODSkipROM(void);
 
int MXC_OWM_Resume(void);
 
int MXC_OWM_SearchROM(int newSearch, uint8_t *ROMCode);
 
void MXC_OWM_ClearFlags(uint32_t mask);
 
unsigned MXC_OWM_GetFlags(void);
 
void MXC_OWM_SetExtPullup(int enable);
 
void MXC_OWM_SetOverdrive(int enable);
 
void MXC_OWM_EnableInt(int flags);
 
void MXC_OWM_DisableInt(int flags);
 
int MXC_OWM_SetForcePresenceDetect(int enable);
 
int MXC_OWM_SetInternalPullup(int enable);
 
int MXC_OWM_SetExternalPullup(mxc_owm_ext_pu_t ext_pu_mode);
 
int MXC_OWM_SystemClockUpdated(void);
 
int MXC_OWM_SetSearchROMAccelerator(int enable);
 
int MXC_OWM_BitBang_Init(int initialState);
 
int MXC_OWM_BitBang_Read(void);
 
int MXC_OWM_BitBang_Write(int state);
 
int MXC_OWM_BitBang_Disable(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_OWM_H_