hpm_owr_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
#ifndef HPM_OWR_DRV_H
#define HPM_OWR_DRV_H
 
#include "hpm_common.h"
#include "hpm_owr_regs.h"
 
/*---------------------------------------------------------------------
 *  Macro Constant Declarations
 *-------------------------------------------------------------------*/
#ifndef OWR_RPP_TIMEOUT
#define OWR_RPP_TIMEOUT (50000U)
#endif
 
#ifndef OWR_WR_TIMEOUT
#define OWR_WR_TIMEOUT (50000U)
#endif
 
/*---------------------------------------------------------------------
 *  Typedef Enum Declarations
 *-------------------------------------------------------------------*/
 
typedef enum {
    owr_irq_receive_shift_register_full = OWR_IRQ_STS_RSRF_MASK,
    owr_irq_receive_buff_full = OWR_IRQ_STS_RBF_MASK,
    owr_irq_transmit_shift_register_empty = OWR_IRQ_STS_TEMT_MASK,
    owr_irq_transmit_buffer_empty = OWR_IRQ_STS_TBE_MASK,
    owr_irq_presence_detected = OWR_IRQ_STS_PST_DET_MASK
} owr_irq_event_t;
 
typedef struct {
    uint32_t clock_source_frequency;
} owr_config_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_stat_t owr_sw_reset(OWR_Type *ptr);
 
hpm_stat_t owr_init(OWR_Type *ptr, owr_config_t *config);
 
hpm_stat_t owr_reset_and_presence_pulses(OWR_Type *ptr);
 
hpm_stat_t owr_get_presence_status(OWR_Type *ptr, uint32_t *status);
 
hpm_stat_t owr_release_bus(OWR_Type *ptr);
 
hpm_stat_t owr_write_data(OWR_Type *ptr, uint8_t data);
 
hpm_stat_t owr_read_data(OWR_Type *ptr, uint8_t *data);
 
hpm_stat_t owr_clear_irq_status(OWR_Type *ptr, uint32_t mask);
 
hpm_stat_t owr_enable_interrupts(OWR_Type *ptr, uint32_t mask);
 
hpm_stat_t owr_disable_interrupts(OWR_Type *ptr, uint32_t mask);
 
hpm_stat_t owr_get_irq_status(OWR_Type *ptr, uint32_t *status);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* HPM_OWR_DRV_H */