| /Zephyr-latest/include/zephyr/ipc/ |
| D | ipc_service_backend.h | 4 * SPDX-License-Identifier: Apache-2.0
30 /** @brief Pointer to the function that will be used to open an instance
32 * @param[in] instance Instance pointer.
34 * @retval -EALREADY when the instance is already opened.
40 int (*open_instance)(const struct device *instance);
42 /** @brief Pointer to the function that will be used to close an instance
44 * @param[in] instance Instance pointer.
46 * @retval -EALREADY when the instance is not already inited.
52 int (*close_instance)(const struct device *instance);
56 * @param[in] instance Instance pointer.
[all …]
|
| /Zephyr-latest/tests/subsys/testsuite/fff_fake_contexts/include/zephyr/ |
| D | called_API.h | 4 * SPDX-License-Identifier: Apache-2.0
16 /* A container struct for hidden instance data */
20 * @brief Provide an instance handle to a session of the called_API.
23 * It represents a routine which provides call-unique data to the caller
28 * @param instance_out Session instance handle for caller to use.
31 * @return -EINVAL if invalid parameter(s)
32 * @return -E2BIG if more calls were made than expected.
37 * @brief Return an instance handle to a session of the called_API.
40 * It represents a routine which requires specific data from the caller
43 * a way to verify a specific calling sequence was made
[all …]
|
| /Zephyr-latest/dts/bindings/dma/ |
| D | zephyr,dma-emul.yaml | 2 # SPDX-License-Identifier: Apache-2.0
6 include: dma-controller.yaml
8 compatible: zephyr,dma-emul
11 stack-size:
15 Stack size (in bytes) for the instance-specific work_q thread.
20 Priority for the instance-specific work_q thread.
|
| /Zephyr-latest/doc/build/dts/ |
| D | dt-vs-kconfig.rst | 12 * Use devicetree to describe **hardware** and its **boot-time configuration**.
13 Examples include peripherals on a board, boot-time clock frequencies,
29 * Additionally, the UART **boot-time configuration** is also described with
32 their boot-time configuration is described in devicetree.
38 As another example, consider a device with a 2.4GHz, multi-protocol radio
43 * **Boot-time configuration** for the radio, such as TX power in dBm, should
49 instance of a driver (that is itself enabled by Kconfig) have been
51 :ref:`status <dt-important-props>` keyword on the corresponding hardware
52 instance.
56 * Because Kconfig is unable to flexibly control some instance-specific driver
[all …]
|
| /Zephyr-latest/include/zephyr/logging/ |
| D | log.h | 4 * SPDX-License-Identifier: Apache-2.0
117 * @brief Writes an ERROR level message associated with the instance to the log.
119 * Message is associated with specific instance of the module which has
124 * @param _log_inst Pointer to the log structure associated with the instance.
132 * @brief Writes a WARNING level message associated with the instance to the
135 * Message is associated with specific instance of the module which has
140 * @param _log_inst Pointer to the log structure associated with the instance.
148 * @brief Writes an INFO level message associated with the instance to the log.
150 * Message is associated with specific instance of the module which has
155 * @param _log_inst Pointer to the log structure associated with the instance.
[all …]
|
| D | log_output_custom.h | 5 * SPDX-License-Identifier: Apache-2.0
27 * @param log_output Pointer to the log output instance.
43 * into a specific logger instance.
51 * @param output The logger instance to write to
70 * @param output The logger instance to write to
83 * @param output Pointer to the log output instance.
|
| /Zephyr-latest/include/zephyr/input/ |
| D | input_kbd_matrix.h | 4 * SPDX-License-Identifier: Apache-2.0
26 #define INPUT_KBD_MATRIX_COLUMN_DRIVE_NONE -1
29 #define INPUT_KBD_MATRIX_COLUMN_DRIVE_ALL -2
46 * @brief Enables or disables a specific row, column combination in the actual
49 * This allows enabling or disabling specific row, column combination in the
51 * present in some configuration, and the specific configuration is determined
61 * @retval -errno Negative errno if row or col are out of range for the device.
77 * @brief Request to drive a specific column.
79 * Request to drive a specific matrix column, or none, or all.
141 BUILD_ASSERT(IN_RANGE(_row_size, 1, INPUT_KBD_MATRIX_ROW_BITS), "invalid row-size"); \
[all …]
|
| /Zephyr-latest/include/zephyr/drivers/ |
| D | hwspinlock.h | 4 * SPDX-License-Identifier: Apache-2.0
65 * This function is used for try to lock specific HW spinlock. It should
68 * @param dev HW spinlock device instance.
72 * @retval -errno In case of any failure.
79 (const struct hwspinlock_driver_api *)dev->api; in z_impl_hwspinlock_trylock()
81 if (api->trylock == NULL) { in z_impl_hwspinlock_trylock()
82 return -ENOSYS; in z_impl_hwspinlock_trylock()
85 return api->trylock(dev, id); in z_impl_hwspinlock_trylock()
91 * This function is used to lock specific HW spinlock. It should be
94 * @param dev HW spinlock device instance.
[all …]
|
| D | dma.h | 10 * SPDX-License-Identifier: Apache-2.0
56 * This and higher values are dma controller or soc specific.
137 * - 0b00 increment
138 * - 0b01 decrement
139 * - 0b10 no change
145 * - 0b00 increment
146 * - 0b01 decrement
147 * - 0b10 no change
154 /** FIFO fill before starting transfer, HW specific meaning */
159 * - 0b0 source request service upon data availability
[all …]
|
| D | w1.h | 5 * SPDX-License-Identifier: Apache-2.0
10 * @brief Public 1-Wire Driver APIs
27 * @brief 1-Wire Interface
28 * @defgroup w1_interface 1-Wire Interface
46 (FOR_EACH(F1, (+), DT_SUPPORTS_DEP_ORDS(node_id)) - 1)
53 * @brief Defines the 1-Wire master settings types, which are runtime configurable.
74 /** Configuration common to all 1-Wire master implementations. */
80 /** Data common to all 1-Wire master implementations. */
118 struct w1_master_data *ctrl_data = (struct w1_master_data *)dev->data; in z_impl_w1_change_bus_lock()
119 const struct w1_driver_api *api = (const struct w1_driver_api *)dev->api; in z_impl_w1_change_bus_lock()
[all …]
|
| D | emul.h | 5 * SPDX-License-Identifier: Apache-2.0
12 * @brief Emulators used to test drivers and higher-level code that uses them
24 /* #includes required after forward-declaration of struct emul later defined in this header. */
78 /** An emulator instance - represents the *target* emulated device/peripheral that is
85 /** handle to the device for which this provides low-level emulation */
87 /** Emulator-specific configuration data */
89 /** Emulator-specific data */
102 /** Address of the API structure exposed by the emulator instance */
137 * @param data_ptr emulator-specific data
138 * @param cfg_ptr emulator-specific configuration data
[all …]
|
| D | dai.h | 4 * SPDX-License-Identifier: Apache-2.0
24 * with bespoke data argument for device/vendor specific config. There are also
25 * optional timestamping functions to get device specific audio clock time.
48 * clock-related configurations w.r.t the DAI
164 /** @brief Optional - Pre Start the transmission / reception of data.
183 * memory block. Behavior is implementation specific but usually this
188 /** @brief Optional - Post Stop the transmission / reception of data.
261 /** DAI specific data stream format. */
263 /** DAI specific configuration options. */
269 /** DAI specific link configuration. */
[all …]
|
| D | pwm.h | 3 * Copyright (c) 2020-2021 Vestas Wind Systems A/S
5 * SPDX-License-Identifier: Apache-2.0
34 #include <zephyr/dt-bindings/pwm/pwm.h>
76 * The upper 8 bits are reserved for SoC specific flags.
99 /** PWM device instance. */
121 * pwm-names = "alpha", "beta";
146 * @param name Lowercase-and-underscores name of a pwms element as defined by
147 * the node's pwm-names property.
163 * instance.
165 * @param inst DT_DRV_COMPAT instance number
[all …]
|
| D | espi_emul.h | 4 * SPDX-License-Identifier: Apache-2.0
41 * @param target The device Emulator instance
46 * @retval -EIO General input / output error.
55 * @param target The device Emulator instance
60 * @retval -EIO General input / output error.
69 * @param target The device Emulator instance
83 * @param chipsel Chip-select value
91 * calling specific callbacks.
93 * @param dev Device instance of emulated eSPI controller
97 * @retval -EIO General input / output error.
[all …]
|
| /Zephyr-latest/doc/services/ipc/ipc_service/ |
| D | ipc_service.rst | 16 An IPC service communication channel consists of one instance and one or
17 several endpoints associated with the instance.
19 An instance is the external representation of a physical communication channel
21 representation of the instance is peculiar to each backend.
23 An individual instance is not used to send data between domains/CPUs. To send
25 instance. This allows for the connection of the two domains of interest.
27 It is possible to have zero or multiple endpoints for one single instance,
29 Endpoint prioritization and multi-instance ability highly depend on the backend
33 two domains (connected by the instance). An endpoint is always associated to an
34 instance.
[all …]
|
| /Zephyr-latest/include/zephyr/bluetooth/mesh/ |
| D | health_srv.h | 8 * SPDX-License-Identifier: Apache-2.0
32 * vendor. Vendor specific faults should be interpreted in the context
39 * specific fault values are used.
46 * @param model Health Server model instance to get faults of.
67 * vendor. Vendor specific faults should be interpreted in the context
72 * @param model Health Server model instance to get faults of.
89 * @param model Health Server model instance to clear faults of.
96 /** @brief Run a self-test.
98 * The Health server may support up to 256 self-tests for each Company
99 * ID. The behavior for all test IDs are vendor specific, and should be
[all …]
|
| /Zephyr-latest/dts/bindings/mbox/ |
| D | nxp,s32-mru.yaml | 2 # SPDX-License-Identifier: Apache-2.0
8 which are other modules or processors. The interrupts from each MRU instance
9 route to specific Private Peripheral Interrupts (PPIs) of the corresponding
14 - Each channel uses only the first mailbox, as current API does not allow
16 - The MTU is fixed to the size of one mailbox, as current API does not
19 In a normal use-case for IPC, the receiver core must enable and set the number
20 of receive channels on the MRU instance coupled with the core, for instance in
21 a devicetree overlay. In turn, the sender(s) must enable the MRU instance of the
30 rx-channels = <2>;
39 compatible: "nxp,s32-mru"
[all …]
|
| /Zephyr-latest/include/zephyr/bluetooth/audio/ |
| D | csip.h | 7 * Copyright (c) 2021-2024 Nordic Semiconductor ASA
9 * SPDX-License-Identifier: Apache-2.0
80 /** SIRK only available out-of-band */
95 /** @brief Opaque Coordinated Set Identification Service instance. */
172 * Mandatory parent service pointer if this CSIS instance is included
189 * @return The first CSIS attribute instance.
194 * @brief Register a Coordinated Set Identification Service instance.
212 * @brief Unregister a Coordinated Set Identification Service instance.
214 * This will unregister and disable the service instance.
223 * @brief Set the SIRK of a service instance
[all …]
|
| /Zephyr-latest/modules/openthread/platform/ |
| D | platform-zephyr.h | 4 * SPDX-License-Identifier: Apache-2.0
10 * This file includes the Zephyr platform-specific initializers.
18 #include <openthread/instance.h>
30 * @param[in] aInstance The OpenThread instance structure.
44 * @param[in] aInstance The OpenThread instance structure.
52 * @param[in] aInstance The OpenThread instance structure.
66 * @param[in] aInstance The OpenThread instance structure.
|
| D | platform.c | 4 * SPDX-License-Identifier: Apache-2.0
10 * This file includes the platform-specific initializers.
14 #include <openthread/instance.h>
17 #include "platform-zephyr.h"
|
| /Zephyr-latest/subsys/testsuite/include/zephyr/ |
| D | fff_extensions.h | 4 * SPDX-License-Identifier: Apache-2.0
34 * fake functions needing call-specific context data.
42 * struct instance * const instance;
47 * const struct instance **instance_out)
57 * if (context->result == 0)
61 * *instance_out = context->instance;
64 * return context->result;
76 * @param HANDLERBODY in-line custom fake handling logic
88 FUNCNAME##_fake.return_val_seq_idx - 1;\
|
| /Zephyr-latest/include/zephyr/drivers/usb/ |
| D | emul_bc12.h | 4 * SPDX-License-Identifier: Apache-2.0
45 * The corresponding BC1.2 emulator updates the vendor specific registers
49 * @param target Pointer to the emulator structure for the BC1.2 emulator instance.
54 * @retval -EINVAL if the partner type is not supported.
60 (const struct bc12_emul_driver_api *)target->backend_api; in bc12_emul_set_charging_partner()
62 return backend_api->set_charging_partner(target, partner_type); in bc12_emul_set_charging_partner()
68 * The corresponding BC1.2 emulator updates the vendor specific registers
73 * @param target Pointer to the emulator structure for the BC1.2 emulator instance.
78 * @retval -EINVAL if the connection/disconnection of PD partner is not supported.
83 (const struct bc12_emul_driver_api *)target->backend_api; in bc12_emul_set_pd_partner()
[all …]
|
| /Zephyr-latest/include/zephyr/drivers/stepper/ |
| D | stepper_drv8424.h | 4 * @brief Public API for DRV8424 Stepper Controller Specific Functions
9 * SPDX-FileCopyrightText: Copyright (c) 2024 Navimatix GmbH
11 * SPDX-License-Identifier: Apache-2.0
24 * @param dev Pointer to the stepper motor controller instance
|
| /Zephyr-latest/dts/bindings/gpio/ |
| D | nxp,pcal64xxa-base.yaml | 3 # SPDX-License-Identifier: Apache-2.0
5 include: [i2c-device.yaml, gpio-controller.yaml]
8 int-gpios:
9 type: phandle-array
11 GPIO connected to the controller INT pin. This pin is active-low.
13 reset-gpios:
14 type: phandle-array
16 GPIO connected to the controller RESET pin. This pin is active-low.
18 no-auto-reset:
22 of for instance an external state retention of the port expander. If
[all …]
|
| /Zephyr-latest/drivers/clock_control/ |
| D | clock_control_mcux_ccm_rev2.c | 4 * SPDX-License-Identifier: Apache-2.0
10 #include <zephyr/dt-bindings/clock/imx_ccm_rev2.h>
21 uint32_t peripheral, instance; in mcux_ccm_on() local
24 instance = (clock_name & IMX_CCM_INSTANCE_MASK); in mcux_ccm_on()
44 (void)instance; in mcux_ccm_on()
60 uint32_t clock_root, peripheral, instance; in mcux_ccm_get_subsys_rate() local
63 instance = (clock_name & IMX_CCM_INSTANCE_MASK); in mcux_ccm_get_subsys_rate()
68 clock_root = kCLOCK_Root_Lpi2c0102 + instance; in mcux_ccm_get_subsys_rate()
72 clock_root = kCLOCK_Root_Lpi2c1 + instance; in mcux_ccm_get_subsys_rate()
80 clock_root = kCLOCK_Root_I3c1 + instance; in mcux_ccm_get_subsys_rate()
[all …]
|
