usbc.h

Go to the documentation of this file.

/*
 * Copyright 2022 The Chromium OS Authors
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_USBC_H_
#define ZEPHYR_INCLUDE_USBC_H_
 
#include <zephyr/types.h>
#include <zephyr/device.h>
#include <zephyr/drivers/usb_c/usbc_tcpc.h>
#include <zephyr/drivers/usb_c/usbc_vbus.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define FIXED_5V_100MA_RDO 0x1100280a
 
enum usbc_policy_request_t {
        REQUEST_NOP,
        REQUEST_TC_DISABLED,
        REQUEST_TC_ERROR_RECOVERY,
        REQUEST_TC_END,
 
        REQUEST_PE_DR_SWAP,
        REQUEST_PE_HARD_RESET_SEND,
        REQUEST_PE_SOFT_RESET_SEND,
        REQUEST_PE_GET_SRC_CAPS,
        REQUEST_GET_SNK_CAPS,
        REQUEST_PE_GOTO_MIN,
};
 
enum usbc_policy_notify_t {
        MSG_ACCEPT_RECEIVED,
        MSG_REJECTED_RECEIVED,
        MSG_DISCARDED,
        MSG_NOT_SUPPORTED_RECEIVED,
        DATA_ROLE_IS_UFP,
        DATA_ROLE_IS_DFP,
        PD_CONNECTED,
        NOT_PD_CONNECTED,
        TRANSITION_PS,
        PORT_PARTNER_NOT_RESPONSIVE,
        PROTOCOL_ERROR,
        SNK_TRANSITION_TO_DEFAULT,
        HARD_RESET_RECEIVED,
        POWER_CHANGE_0A0,
        POWER_CHANGE_DEF,
        POWER_CHANGE_1A5,
        POWER_CHANGE_3A0,
        SENDER_RESPONSE_TIMEOUT,
        SOURCE_CAPABILITIES_RECEIVED,
};
 
enum usbc_policy_check_t {
        CHECK_POWER_ROLE_SWAP,
        CHECK_DATA_ROLE_SWAP_TO_DFP,
        CHECK_DATA_ROLE_SWAP_TO_UFP,
        CHECK_SNK_AT_DEFAULT_LEVEL,
        CHECK_VCONN_CONTROL,
        CHECK_SRC_PS_AT_DEFAULT_LEVEL,
};
 
enum usbc_policy_wait_t {
        WAIT_SINK_REQUEST,
        WAIT_POWER_ROLE_SWAP,
        WAIT_DATA_ROLE_SWAP,
        WAIT_VCONN_SWAP,
};
 
enum usbc_snk_req_reply_t {
        SNK_REQUEST_VALID,
        SNK_REQUEST_REJECT,
        SNK_REQUEST_WAIT,
};
 
typedef int (*policy_cb_get_snk_cap_t)(const struct device *dev, uint32_t **pdos, int *num_pdos);
typedef void (*policy_cb_set_src_cap_t)(const struct device *dev, const uint32_t *pdos,
                                        const int num_pdos);
 
typedef bool (*policy_cb_check_t)(const struct device *dev,
                                  const enum usbc_policy_check_t policy_check);
 
typedef bool (*policy_cb_wait_notify_t)(const struct device *dev,
                                        const enum usbc_policy_wait_t wait_notify);
 
typedef void (*policy_cb_notify_t)(const struct device *dev,
                                   const enum usbc_policy_notify_t policy_notify);
 
typedef uint32_t (*policy_cb_get_rdo_t)(const struct device *dev);
 
typedef bool (*policy_cb_is_snk_at_default_t)(const struct device *dev);
 
typedef int (*policy_cb_get_src_caps_t)(const struct device *dev, const uint32_t **pdos,
                                        uint32_t *num_pdos);
 
typedef enum usbc_snk_req_reply_t (*policy_cb_check_sink_request_t)(const struct device *dev,
                                                                    const uint32_t request_msg);
 
typedef bool (*policy_cb_is_ps_ready_t)(const struct device *dev);
 
typedef bool (*policy_cb_present_contract_is_valid_t)(const struct device *dev,
                                                   const uint32_t present_contract);
 
typedef bool (*policy_cb_change_src_caps_t)(const struct device *dev);
 
typedef void (*policy_cb_set_port_partner_snk_cap_t)(const struct device *dev, const uint32_t *pdos,
                                                     const int num_pdos);
typedef int (*policy_cb_get_src_rp_t)(const struct device *dev, enum tc_rp_value *rp);
typedef int (*policy_cb_src_en_t)(const struct device *dev, bool en);
int usbc_start(const struct device *dev);
 
int usbc_suspend(const struct device *dev);
 
int usbc_request(const struct device *dev, const enum usbc_policy_request_t req);
 
void usbc_bypass_next_sleep(const struct device *dev);
 
void usbc_set_dpm_data(const struct device *dev, void *dpm_data);
 
void *usbc_get_dpm_data(const struct device *dev);
 
void usbc_set_vconn_control_cb(const struct device *dev, const tcpc_vconn_control_cb_t cb);
 
void usbc_set_vconn_discharge_cb(const struct device *dev, const tcpc_vconn_discharge_cb_t cb);
 
void usbc_set_policy_cb_check(const struct device *dev, const policy_cb_check_t cb);
 
void usbc_set_policy_cb_notify(const struct device *dev, const policy_cb_notify_t cb);
 
void usbc_set_policy_cb_wait_notify(const struct device *dev, const policy_cb_wait_notify_t cb);
 
void usbc_set_policy_cb_get_snk_cap(const struct device *dev, const policy_cb_get_snk_cap_t cb);
 
void usbc_set_policy_cb_set_src_cap(const struct device *dev, const policy_cb_set_src_cap_t cb);
 
void usbc_set_policy_cb_get_rdo(const struct device *dev, const policy_cb_get_rdo_t cb);
 
void usbc_set_policy_cb_is_snk_at_default(const struct device *dev,
                                          const policy_cb_is_snk_at_default_t cb);
 
void usbc_set_policy_cb_get_src_rp(const struct device *dev, const policy_cb_get_src_rp_t cb);
 
void usbc_set_policy_cb_src_en(const struct device *dev, const policy_cb_src_en_t cb);
 
void usbc_set_policy_cb_get_src_caps(const struct device *dev, const policy_cb_get_src_caps_t cb);
 
void usbc_set_policy_cb_check_sink_request(const struct device *dev,
                                           const policy_cb_check_sink_request_t cb);
 
void usbc_set_policy_cb_is_ps_ready(const struct device *dev,
                                          const policy_cb_is_ps_ready_t cb);
 
void usbc_set_policy_cb_present_contract_is_valid(const struct device *dev,
                                               const policy_cb_present_contract_is_valid_t cb);
 
void usbc_set_policy_cb_change_src_caps(const struct device *dev,
                                        const policy_cb_change_src_caps_t cb);
 
void usbc_set_policy_cb_set_port_partner_snk_cap(const struct device *dev,
                                                 const policy_cb_set_port_partner_snk_cap_t cb);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_USBC_H_ */