Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
w1_driver_api Struct Reference

@driver_ops{1-Wire} More...

#include <w1.h>

Data Fields

w1_reset_bus_t reset_bus
 @driver_ops_mandatory Reset the 1-Wire bus to prepare slaves for communication.
w1_read_bit_t read_bit
 @driver_ops_mandatory Read a single bit from the 1-Wire bus.
w1_write_bit_t write_bit
 @driver_ops_mandatory Write a single bit to the 1-Wire bus.
w1_read_byte_t read_byte
 @driver_ops_mandatory Read a single byte from the 1-Wire bus.
w1_write_byte_t write_byte
 @driver_ops_mandatory Write a single byte to the 1-Wire bus.
w1_read_block_t read_block
 @driver_ops_optional Read a block of data from the 1-Wire bus.
w1_write_block_t write_block
 @driver_ops_optional Write a block of data to the 1-Wire bus.
w1_configure_t configure
 @driver_ops_mandatory Configure parameters of the 1-Wire master.
w1_change_bus_lock_t change_bus_lock
 @driver_ops_optional Lock or unlock bus access.

Detailed Description

@driver_ops{1-Wire}

Field Documentation

◆ change_bus_lock

w1_change_bus_lock_t w1_driver_api::change_bus_lock

@driver_ops_optional Lock or unlock bus access.

If not implemented, the subsystem falls back to a mutex-based lock.

◆ configure

w1_configure_t w1_driver_api::configure

@driver_ops_mandatory Configure parameters of the 1-Wire master.

◆ read_bit

w1_read_bit_t w1_driver_api::read_bit

@driver_ops_mandatory Read a single bit from the 1-Wire bus.

◆ read_block

w1_read_block_t w1_driver_api::read_block

@driver_ops_optional Read a block of data from the 1-Wire bus.

If not implemented, the subsystem falls back to repeated w1_driver_api::read_byte calls.

◆ read_byte

w1_read_byte_t w1_driver_api::read_byte

@driver_ops_mandatory Read a single byte from the 1-Wire bus.

◆ reset_bus

w1_reset_bus_t w1_driver_api::reset_bus

@driver_ops_mandatory Reset the 1-Wire bus to prepare slaves for communication.

◆ write_bit

w1_write_bit_t w1_driver_api::write_bit

@driver_ops_mandatory Write a single bit to the 1-Wire bus.

◆ write_block

w1_write_block_t w1_driver_api::write_block

@driver_ops_optional Write a block of data to the 1-Wire bus.

If not implemented, the subsystem falls back to repeated w1_driver_api::write_byte calls.

◆ write_byte

w1_write_byte_t w1_driver_api::write_byte

@driver_ops_mandatory Write a single byte to the 1-Wire bus.


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/w1.h