Function otPlatRadioSetChannelTargetPower

Source
pub unsafe extern "C" fn otPlatRadioSetChannelTargetPower(
    aInstance: *mut otInstance,
    aChannel: u8,
    aTargetPower: i16,
) -> otError
Expand description

Set the target power for the given channel.

@note This API is an optional radio platform API. It’s up to the platform layer to implement it. If this function and otPlatRadioSetTransmitPower() are implemented at the same time: - If neither of these two functions is called, the radio outputs the platform-defined default power. - If both functions are called, the last one to be called takes effect.

The radio driver should set the actual output power to be less than or equal to the @p aTargetPower and as close as possible to the @p aTargetPower. If the @p aTargetPower is lower than the minimum output power supported by the platform, the output power should be set to the minimum output power supported by the platform. If the @p aTargetPower is higher than the maximum output power supported by the platform, the output power should be set to the maximum output power supported by the platform. If the @p aTargetPower is set to INT16_MAX, the corresponding channel is disabled.

@param[in] aInstance The OpenThread instance structure. @param[in] aChannel The radio channel. @param[in] aTargetPower The target power in 0.01dBm.

@retval OT_ERROR_NONE Successfully set the target power. @retval OT_ERROR_INVALID_ARGS The @p aChannel is invalid. @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.