Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
target_device.h
Go to the documentation of this file.
1/*
2 * Copyright 2022 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_I3C_TARGET_DEVICE_H_
8#define ZEPHYR_INCLUDE_DRIVERS_I3C_TARGET_DEVICE_H_
9
17#include <errno.h>
18#include <stddef.h>
19#include <stdint.h>
20
21#include <zephyr/device.h>
22#include <zephyr/sys/slist.h>
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28struct i3c_driver_api;
29
90
117
135 int (*write_requested_cb)(struct i3c_target_config *config);
136
157 uint8_t val);
158
180 uint8_t *val);
181
203 uint8_t *val);
204
205#ifdef CONFIG_I3C_TARGET_BUFFER_MODE
219 void (*buf_write_received_cb)(struct i3c_target_config *config, uint8_t *ptr, uint32_t len);
220
245 int (*buf_read_requested_cb)(struct i3c_target_config *config, uint8_t **ptr, uint32_t *len,
246 uint8_t *hdr_mode);
247#endif
263 int (*stop_cb)(struct i3c_target_config *config);
264
280};
281
282__subsystem struct i3c_target_driver_api {
283 int (*driver_register)(const struct device *dev);
284 int (*driver_unregister)(const struct device *dev);
285};
286
299static inline int i3c_target_controller_handoff(const struct device *dev,
300 bool accept)
301{
302 const struct i3c_driver_api *api =
303 (const struct i3c_driver_api *)dev->api;
304
305 if (api->target_controller_handoff == NULL) {
306 return -ENOSYS;
307 }
308
309 return api->target_controller_handoff(dev, accept);
310}
311
336static inline int i3c_target_tx_write(const struct device *dev,
337 uint8_t *buf, uint16_t len, uint8_t hdr_mode)
338{
339 const struct i3c_driver_api *api =
340 (const struct i3c_driver_api *)dev->api;
341
342 if (api->target_tx_write == NULL) {
343 return -ENOSYS;
344 }
345
346 return api->target_tx_write(dev, buf, len, hdr_mode);
347}
348
372static inline int i3c_target_register(const struct device *dev,
373 struct i3c_target_config *cfg)
374{
375 const struct i3c_driver_api *api =
376 (const struct i3c_driver_api *)dev->api;
377
378 if (api->target_register == NULL) {
379 return -ENOSYS;
380 }
381
382 return api->target_register(dev, cfg);
383}
384
401static inline int i3c_target_unregister(const struct device *dev,
402 struct i3c_target_config *cfg)
403{
404 const struct i3c_driver_api *api =
405 (const struct i3c_driver_api *)dev->api;
406
407 if (api->target_unregister == NULL) {
408 return -ENOSYS;
409 }
410
411 return api->target_unregister(dev, cfg);
412}
413
414#ifdef __cplusplus
415}
416#endif
417
422#endif /* ZEPHYR_INCLUDE_DRIVERS_I3C_TARGET_DEVICE_H_ */
System error numbers.
static int i3c_target_controller_handoff(const struct device *dev, bool accept)
Accept or Decline Controller Handoffs.
Definition target_device.h:299
static int i3c_target_unregister(const struct device *dev, struct i3c_target_config *cfg)
Unregisters the provided config as target device.
Definition target_device.h:401
static int i3c_target_register(const struct device *dev, struct i3c_target_config *cfg)
Registers the provided config as target device of a controller.
Definition target_device.h:372
static int i3c_target_tx_write(const struct device *dev, uint8_t *buf, uint16_t len, uint8_t hdr_mode)
Writes to the target's TX FIFO.
Definition target_device.h:336
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
int accept(int sock, struct sockaddr *addr, socklen_t *addrlen)
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:504
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:510
Configuration parameters for I3C hardware to act as target device.
Definition target_device.h:36
uint8_t bcr
Bus Characteristics Register (BCR).
Definition target_device.h:74
bool enabled
If the hardware is currently acting as a target device on the bus.
Definition target_device.h:41
bool pid_random
True if lower 32-bit of Provisioned ID is random.
Definition target_device.h:71
uint16_t max_read_len
Maximum Read Length (MRL).
Definition target_device.h:80
uint64_t pid
Provisioned ID.
Definition target_device.h:63
uint8_t supported_hdr
Bit mask of supported HDR modes (0 - 7).
Definition target_device.h:88
uint8_t dynamic_addr
I3C target dynamic address.
Definition target_device.h:52
uint8_t static_addr
I3C target static address.
Definition target_device.h:60
uint16_t max_write_len
Maximum Write Length (MWL).
Definition target_device.h:83
uint8_t dcr
Device Characteristics Register (DCR).
Definition target_device.h:77
Definition target_device.h:118
int(* stop_cb)(struct i3c_target_config *config)
Function called when a stop condition is observed after a start condition addressed to a particular d...
Definition target_device.h:263
int(* controller_handoff_cb)(struct i3c_target_config *config)
Function called when an active controller handoffs controlership to this target.
Definition target_device.h:279
int(* write_received_cb)(struct i3c_target_config *config, uint8_t val)
Function called when a write to the device is continued.
Definition target_device.h:156
int(* read_requested_cb)(struct i3c_target_config *config, uint8_t *val)
Function called when a read from the device is initiated.
Definition target_device.h:179
int(* write_requested_cb)(struct i3c_target_config *config)
Function called when a write to the device is initiated.
Definition target_device.h:135
int(* read_processed_cb)(struct i3c_target_config *config, uint8_t *val)
Function called when a read from the device is continued.
Definition target_device.h:202
Structure describing a device that supports the I3C target API.
Definition target_device.h:102
const struct i3c_target_callbacks * callbacks
Callback functions.
Definition target_device.h:115
sys_snode_t node
Definition target_device.h:103
uint8_t address
Address for this target device.
Definition target_device.h:112
uint8_t flags
Flags for the target device defined by I3C_TARGET_FLAGS_* constants.
Definition target_device.h:109
Definition target_device.h:282
int(* driver_unregister)(const struct device *dev)
Definition target_device.h:284
int(* driver_register)(const struct device *dev)
Definition target_device.h:283