1-Wire Master (OWM)

Modules
	OWM_Registers

Data Structures
struct	mxc_owm_cfg_t

Macros
#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

Enumerations
enum	mxc_owm_ext_pu_t

Functions
int	MXC_OWM_Init (const mxc_owm_cfg_t *cfg)
void	MXC_OWM_Shutdown (void)
int	MXC_OWM_Reset (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)

Detailed Description

---

Data Structure Documentation

mxc_owm_cfg_t

struct mxc_owm_cfg_t

Structure type for 1-Wire Master configuration.

Data Fields
uint8_t	int_pu_en
mxc_owm_ext_pu_t	ext_pu_mode
uint8_t	long_line_mode

Field Documentation

ext_pu_mode

mxc_owm_ext_pu_t ext_pu_mode

See mxc_owm_ext_pu_t.

int_pu_en

uint8_t int_pu_en

1 = internal pullup on.

long_line_mode

uint8_t long_line_mode

1 = long line mode enable.

Macro Definition Documentation

MATCH_ROM_COMMAND

#define MATCH_ROM_COMMAND   0x55

Match ROM Command

OD_MATCH_ROM_COMMAND

#define OD_MATCH_ROM_COMMAND   0x69

Overdrive Match ROM Command

OD_SKIP_ROM_COMMAND

#define OD_SKIP_ROM_COMMAND   0x3C

Overdrive Skip ROM Command

READ_ROM_COMMAND

#define READ_ROM_COMMAND   0x33

Read ROM Command

RESUME_COMMAND

#define RESUME_COMMAND   0xA5

Resume Command

SEARCH_ROM_COMMAND

#define SEARCH_ROM_COMMAND   0xF0

Search ROM Command

SKIP_ROM_COMMAND

#define SKIP_ROM_COMMAND   0xCC

Skip ROM Command

Enumeration Type Documentation

mxc_owm_ext_pu_t

enum mxc_owm_ext_pu_t

Enumeration type for specifying options for 1-Wire external pullup mode.

Enumerator
MXC_OWM_EXT_PU_ACT_HIGH	Pullup pin is active high when enabled.
MXC_OWM_EXT_PU_ACT_LOW	Pullup pin is active low when enabled.
MXC_OWM_EXT_PU_UNUSED	Pullup pin is not used for an external pullup.

Function Documentation

MXC_OWM_BitBang_Disable()

int MXC_OWM_BitBang_Disable

(

void

)

Disable Bit Bang mode.

Returns

See Error Codes for a list of return codes.

MXC_OWM_BitBang_Init()

int MXC_OWM_BitBang_Init

(

int

initialState

)

Prepare OWM for bit bang mode.

Parameters

initialState

Starting value of owm

Returns

See Error Codes for a list of return codes.

MXC_OWM_BitBang_Read()

int MXC_OWM_BitBang_Read

(

void

)

Read current value of wire.

Returns

Value of wire

MXC_OWM_BitBang_Write()

int MXC_OWM_BitBang_Write

(

int

state

)

Set value of wire.

Parameters

state

Value to drive wire to

Returns

See Error Codes for a list of return codes.

MXC_OWM_ClearFlags()

void MXC_OWM_ClearFlags

(

uint32_t

mask

)

Clear interrupt flags.

Parameters

mask	Mask of interrupts to clear.

MXC_OWM_DisableInt()

void MXC_OWM_DisableInt

(

int

flags

)

Disables interrupts.

Parameters

flags

which owm interrupts to disable

MXC_OWM_EnableInt()

void MXC_OWM_EnableInt

(

int

flags

)

Enables interrupts.

Parameters

flags

which owm interrupts to enable

MXC_OWM_GetFlags()

unsigned MXC_OWM_GetFlags

(

void

)

Get interrupt flags.

Returns

Mask of active flags.

MXC_OWM_Init()

int MXC_OWM_Init

(

const mxc_owm_cfg_t *

cfg

)

Initialize and enable OWM module.

Parameters

cfg	Pointer to OWM configuration.

Returns

E_NO_ERROR if everything is successful

E_NULL_PTR if parameter is a null pointer

E_BUSY if IOMAN was not configured correctly

E_UNINITIALIZED if OWM CLK disabled

E_NOT_SUPPORTED if 1MHz CLK cannot be created with given system and owm CLK

E_BAD_PARAM if bad cfg parameter passed in

MXC_OWM_MatchROM()

int MXC_OWM_MatchROM

(

uint8_t *

ROMCode

)

Starts 1-Wire communication with Match ROM command.

Parameters

ROMCode

Pointer to buffer with ROM code to match

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset or write fails

MXC_OWM_ODMatchROM()

int MXC_OWM_ODMatchROM

(

uint8_t *

ROMCode

)

Starts 1-Wire communication with Overdrive Match ROM command.

Note

After Overdrive Match ROM command is sent, the OWM is set to overdrive speed. To set back to standard speed use MXC_OWM_SetOverdrive.

Parameters

ROMCode

Pointer to buffer with ROM code to match

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset or write fails

MXC_OWM_ODSkipROM()

int MXC_OWM_ODSkipROM

(

void

)

Starts 1-Wire communication with Overdrive Skip ROM command.

Note

After Overdrive Skip ROM command is sent, the OWM is set to overdrive speed. To set back to standard speed use MXC_OWM_SetOverdrive

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset or write fails

MXC_OWM_Read()

int MXC_OWM_Read	(	uint8_t *	data,
		int	len
	)

Read multiple bytes of data. Will block until transaction is complete.

Parameters

data	Pointer to buffer for read data.
len	Number of bytes to read.

Returns

Number of bytes read if successful

E_COMM_ERR if line short detected before transaction

MXC_OWM_ReadBit()

int MXC_OWM_ReadBit

(

void

)

Read one bit of data. Will block until transaction is complete.

Returns

bit read

MXC_OWM_ReadByte()

int MXC_OWM_ReadByte

(

void

)

Read one byte of data. Will block until transaction is complete.

Returns

data read (1 byte)

MXC_OWM_ReadROM()

int MXC_OWM_ReadROM

(

uint8_t *

ROMCode

)

Starts 1-Wire communication with Read ROM command.

Note

Only use the Read ROM command with one slave on the bus

Parameters

ROMCode

Pointer to buffer for ROM code read

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset, read or write fails

MXC_OWM_Reset()

int MXC_OWM_Reset

(

void

)

Send 1-Wire reset pulse. Will block until transaction is complete.

Returns

0 if no 1-wire devices reponded during the presence pulse, 1 otherwise

MXC_OWM_Resume()

int MXC_OWM_Resume

(

void

)

Starts 1-Wire communication with Resume command.

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset or write fails

MXC_OWM_SearchROM()

int MXC_OWM_SearchROM	(	int	newSearch,
		uint8_t *	ROMCode
	)

Starts 1-Wire communication with Search ROM command.

Parameters

newSearch	(1) = start new search, (0) = continue search for next ROM
ROMCode	Pointer to buffer with ROM code found

Returns

(1) = ROM found, (0) = no new ROM found, end of search

MXC_OWM_SetExternalPullup()

int MXC_OWM_SetExternalPullup

(

mxc_owm_ext_pu_t

ext_pu_mode

)

Enables/Disables the External pullup.

Parameters

ext_pu_mode

See mxc_owm_ext_pu_t for values

Returns

See Error Codes for a list of return codes.

MXC_OWM_SetExtPullup()

void MXC_OWM_SetExtPullup

(

int

enable

)

Enables/Disables the External pullup.

Parameters

enable

(1) = enable, (0) = disable

MXC_OWM_SetForcePresenceDetect()

int MXC_OWM_SetForcePresenceDetect

(

int

enable

)

Enables/Disables driving of OWM_IO low during presence detection.

Parameters

enable

(1) = enable, (0) = disable

Returns

See Error Codes for a list of return codes.

MXC_OWM_SetInternalPullup()

int MXC_OWM_SetInternalPullup

(

int

enable

)

Enables/Disables the Internal pullup.

Parameters

enable

(1) = enable, (0) = disable

Returns

See Error Codes for a list of return codes.

MXC_OWM_SetOverdrive()

void MXC_OWM_SetOverdrive

(

int

enable

)

Enables/Disables Overdrive speed.

Parameters

enable

(1) = overdrive, (0) = standard

MXC_OWM_SetSearchROMAccelerator()

int MXC_OWM_SetSearchROMAccelerator

(

int

enable

)

Enable/Disable Search ROM Accelerator mode.

Parameters

enable

(1) = enable, (0) = disable

Returns

See Error Codes for a list of return codes.

MXC_OWM_SkipROM()

int MXC_OWM_SkipROM

(

void

)

Starts 1-Wire communication with Skip ROM command.

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if reset or write fails

MXC_OWM_SystemClockUpdated()

int MXC_OWM_SystemClockUpdated

(

void

)

Call to correct divider if system clock has changed.

Returns

See Error Codes for a list of return codes.

MXC_OWM_TouchBit()

int MXC_OWM_TouchBit

(

uint8_t

bit

)

Send and receive one bit of data. Will block until transaction is complete.

Parameters

bit	bit to send

Returns

bit read

MXC_OWM_TouchByte()

int MXC_OWM_TouchByte

(

uint8_t

data

)

Send and receive one byte of data. Will block until transaction is complete.

Parameters

data	data to send

Returns

data read (1 byte)

MXC_OWM_Write()

int MXC_OWM_Write	(	uint8_t *	data,
		int	len
	)

Write multiple bytes of data. Will block until transaction is complete.

Parameters

data	Pointer to buffer for write data.
len	Number of bytes to write.

Returns

Number of bytes written if successful

E_COMM_ERR if line short detected before transaction

MXC_OWM_WriteBit()

int MXC_OWM_WriteBit

(

uint8_t

bit

)

Write one bit of data. Will block until transaction is complete.

Parameters

bit	bit to send

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if bit written != bit parameter

MXC_OWM_WriteByte()

int MXC_OWM_WriteByte

(

uint8_t

data

)

Write one byte of data. Will block until transaction is complete.

Parameters

data	data to send

Returns

E_NO_ERROR if everything is successful

E_COMM_ERR if data written != data parameter