hpm_owr_drv.h File Reference

#include "hpm_common.h"
#include "hpm_owr_regs.h"

Go to the source code of this file.

Data Structures
struct	owr_config_t
	OWR config struct. More...

Macros
#define	OWR_RPP_TIMEOUT   (50000U)
#define	OWR_WR_TIMEOUT   (50000U)

Enumerations
enum	owr_irq_t {   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 Type. More...

Functions
hpm_stat_t	owr_sw_reset (OWR_Type *ptr)
	Software Reset OWR. More...
hpm_stat_t	owr_init (OWR_Type *ptr, owr_config_t *config)
	Init OWR. More...
hpm_stat_t	owr_reset_and_presence_pulses (OWR_Type *ptr)
	Reset and presence pulses. More...
hpm_stat_t	owr_get_presence_status (OWR_Type *ptr, uint32_t *status)
	Get presence status. More...
hpm_stat_t	owr_release_bus (OWR_Type *ptr)
	Release bus. More...
hpm_stat_t	owr_write_data (OWR_Type *ptr, uint32_t data)
	Write data. More...
hpm_stat_t	owr_read_data (OWR_Type *ptr, uint32_t *data)
	Read data. More...
hpm_stat_t	owr_clear_irq_status (OWR_Type *ptr, uint32_t mask)
	Clear irq status. More...
hpm_stat_t	owr_enable_interrupts (OWR_Type *ptr, uint32_t mask)
	Enable interrupts. More...
hpm_stat_t	owr_disable_interrupts (OWR_Type *ptr, uint32_t mask)
	Disable interrupts. More...
hpm_stat_t	owr_get_irq_status (OWR_Type *ptr, uint32_t *status)
	Get irq status. More...

Macro Definition Documentation

OWR_RPP_TIMEOUT

#define OWR_RPP_TIMEOUT   (50000U)

OWR_WR_TIMEOUT

#define OWR_WR_TIMEOUT   (50000U)

Enumeration Type Documentation

owr_irq_t

enum owr_irq_t

OWR IRQ Type.

Enumerator
owr_irq_receive_shift_register_full
owr_irq_receive_buff_full
owr_irq_transmit_shift_register_empty
owr_irq_transmit_buffer_empty
owr_irq_presence_detected

Function Documentation

owr_clear_irq_status()

hpm_stat_t owr_clear_irq_status	(	OWR_Type *	ptr,
		uint32_t	mask
	)

Clear irq status.

Parameters

[in]	ptr	OWR base address
[in]	mask	mask of irq status to clear owr_irq_event_t

Returns

hpm_stat_t result of clearing irq status. hpm_stat_t

owr_disable_interrupts()

hpm_stat_t owr_disable_interrupts	(	OWR_Type *	ptr,
		uint32_t	mask
	)

Disable interrupts.

Parameters

[in]	ptr	OWR base address
[in]	mask	mask of interrupts to disable owr_irq_event_t

Returns

hpm_stat_t result of disabling interrupts. hpm_stat_t

owr_enable_interrupts()

hpm_stat_t owr_enable_interrupts	(	OWR_Type *	ptr,
		uint32_t	mask
	)

Enable interrupts.

Parameters

[in]	ptr	OWR base address
[in]	mask	mask of interrupts to enable owr_irq_event_t

Returns

hpm_stat_t result of enabling interrupts. hpm_stat_t

owr_get_irq_status()

hpm_stat_t owr_get_irq_status	(	OWR_Type *	ptr,
		uint32_t *	status
	)

Get irq status.

Parameters

[in]	ptr	OWR base address
[out]	status	pointer to status for storing irq status

Returns

hpm_stat_t result of getting irq status. hpm_stat_t

owr_get_presence_status()

hpm_stat_t owr_get_presence_status	(	OWR_Type *	ptr,
		uint32_t *	status
	)

Get presence status.

Parameters

[in]	ptr	OWR base address
[out]	status	pointer to status for storing presence status

Returns

hpm_stat_t result of getting presence status. hpm_stat_t

owr_init()

hpm_stat_t owr_init	(	OWR_Type *	ptr,
		owr_config_t *	config
	)

Init OWR.

Parameters

[in]	ptr	OWR base address
[in]	config	pointer to config for initializing OWR. owr_config_t

Returns

hpm_stat_t result of init. hpm_stat_t

owr_read_data()

hpm_stat_t owr_read_data	(	OWR_Type *	ptr,
		uint32_t *	data
	)

Read data.

Parameters

[in]	ptr	OWR base address
[out]	data	pointer to data for storing read data

Returns

hpm_stat_t result of reading data. hpm_stat_t

owr_release_bus()

hpm_stat_t owr_release_bus

(

OWR_Type *

ptr

)

Release bus.

Parameters

[in]

ptr

OWR base address

Returns

hpm_stat_t result of releasing bus. hpm_stat_t

owr_reset_and_presence_pulses()

hpm_stat_t owr_reset_and_presence_pulses

(

OWR_Type *

ptr

)

Reset and presence pulses.

Parameters

[in]

ptr

OWR base address

Returns

hpm_stat_t result of reset and presence pulses. hpm_stat_t

owr_sw_reset()

hpm_stat_t owr_sw_reset

(

OWR_Type *

ptr

)

Software Reset OWR.

Parameters

[in]

ptr

OWR base address

Returns

hpm_stat_t result of software reset. hpm_stat_t

owr_write_data()

hpm_stat_t owr_write_data	(	OWR_Type *	ptr,
		uint32_t	data
	)

Write data.

Parameters

[in]	ptr	OWR base address
[in]	data	data to write

Returns

hpm_stat_t result of writing data. hpm_stat_t