13d0407baSopenharmony_ci/* SPDX-License-Identifier: GPL-2.0-or-later */ 23d0407baSopenharmony_ci/* 33d0407baSopenharmony_ci * Copyright 2015-2017 Google, Inc 43d0407baSopenharmony_ci */ 53d0407baSopenharmony_ci 63d0407baSopenharmony_ci#ifndef __LINUX_USB_PD_H 73d0407baSopenharmony_ci#define __LINUX_USB_PD_H 83d0407baSopenharmony_ci 93d0407baSopenharmony_ci#include <linux/kernel.h> 103d0407baSopenharmony_ci#include <linux/types.h> 113d0407baSopenharmony_ci#include <linux/usb/typec.h> 123d0407baSopenharmony_ci 133d0407baSopenharmony_ci/* USB PD Messages */ 143d0407baSopenharmony_cienum pd_ctrl_msg_type { 153d0407baSopenharmony_ci /* 0 Reserved */ 163d0407baSopenharmony_ci PD_CTRL_GOOD_CRC = 1, 173d0407baSopenharmony_ci PD_CTRL_GOTO_MIN = 2, 183d0407baSopenharmony_ci PD_CTRL_ACCEPT = 3, 193d0407baSopenharmony_ci PD_CTRL_REJECT = 4, 203d0407baSopenharmony_ci PD_CTRL_PING = 5, 213d0407baSopenharmony_ci PD_CTRL_PS_RDY = 6, 223d0407baSopenharmony_ci PD_CTRL_GET_SOURCE_CAP = 7, 233d0407baSopenharmony_ci PD_CTRL_GET_SINK_CAP = 8, 243d0407baSopenharmony_ci PD_CTRL_DR_SWAP = 9, 253d0407baSopenharmony_ci PD_CTRL_PR_SWAP = 10, 263d0407baSopenharmony_ci PD_CTRL_VCONN_SWAP = 11, 273d0407baSopenharmony_ci PD_CTRL_WAIT = 12, 283d0407baSopenharmony_ci PD_CTRL_SOFT_RESET = 13, 293d0407baSopenharmony_ci /* 14-15 Reserved */ 303d0407baSopenharmony_ci PD_CTRL_NOT_SUPP = 16, 313d0407baSopenharmony_ci PD_CTRL_GET_SOURCE_CAP_EXT = 17, 323d0407baSopenharmony_ci PD_CTRL_GET_STATUS = 18, 333d0407baSopenharmony_ci PD_CTRL_FR_SWAP = 19, 343d0407baSopenharmony_ci PD_CTRL_GET_PPS_STATUS = 20, 353d0407baSopenharmony_ci PD_CTRL_GET_COUNTRY_CODES = 21, 363d0407baSopenharmony_ci /* 22-31 Reserved */ 373d0407baSopenharmony_ci}; 383d0407baSopenharmony_ci 393d0407baSopenharmony_cienum pd_data_msg_type { 403d0407baSopenharmony_ci /* 0 Reserved */ 413d0407baSopenharmony_ci PD_DATA_SOURCE_CAP = 1, 423d0407baSopenharmony_ci PD_DATA_REQUEST = 2, 433d0407baSopenharmony_ci PD_DATA_BIST = 3, 443d0407baSopenharmony_ci PD_DATA_SINK_CAP = 4, 453d0407baSopenharmony_ci PD_DATA_BATT_STATUS = 5, 463d0407baSopenharmony_ci PD_DATA_ALERT = 6, 473d0407baSopenharmony_ci PD_DATA_GET_COUNTRY_INFO = 7, 483d0407baSopenharmony_ci PD_DATA_ENTER_USB = 8, 493d0407baSopenharmony_ci /* 9-14 Reserved */ 503d0407baSopenharmony_ci PD_DATA_VENDOR_DEF = 15, 513d0407baSopenharmony_ci /* 16-31 Reserved */ 523d0407baSopenharmony_ci}; 533d0407baSopenharmony_ci 543d0407baSopenharmony_cienum pd_ext_msg_type { 553d0407baSopenharmony_ci /* 0 Reserved */ 563d0407baSopenharmony_ci PD_EXT_SOURCE_CAP_EXT = 1, 573d0407baSopenharmony_ci PD_EXT_STATUS = 2, 583d0407baSopenharmony_ci PD_EXT_GET_BATT_CAP = 3, 593d0407baSopenharmony_ci PD_EXT_GET_BATT_STATUS = 4, 603d0407baSopenharmony_ci PD_EXT_BATT_CAP = 5, 613d0407baSopenharmony_ci PD_EXT_GET_MANUFACTURER_INFO = 6, 623d0407baSopenharmony_ci PD_EXT_MANUFACTURER_INFO = 7, 633d0407baSopenharmony_ci PD_EXT_SECURITY_REQUEST = 8, 643d0407baSopenharmony_ci PD_EXT_SECURITY_RESPONSE = 9, 653d0407baSopenharmony_ci PD_EXT_FW_UPDATE_REQUEST = 10, 663d0407baSopenharmony_ci PD_EXT_FW_UPDATE_RESPONSE = 11, 673d0407baSopenharmony_ci PD_EXT_PPS_STATUS = 12, 683d0407baSopenharmony_ci PD_EXT_COUNTRY_INFO = 13, 693d0407baSopenharmony_ci PD_EXT_COUNTRY_CODES = 14, 703d0407baSopenharmony_ci /* 15-31 Reserved */ 713d0407baSopenharmony_ci}; 723d0407baSopenharmony_ci 733d0407baSopenharmony_ci#define PD_REV10 0x0 743d0407baSopenharmony_ci#define PD_REV20 0x1 753d0407baSopenharmony_ci#define PD_REV30 0x2 763d0407baSopenharmony_ci#define PD_MAX_REV PD_REV30 773d0407baSopenharmony_ci 783d0407baSopenharmony_ci#define PD_HEADER_EXT_HDR BIT(15) 793d0407baSopenharmony_ci#define PD_HEADER_CNT_SHIFT 12 803d0407baSopenharmony_ci#define PD_HEADER_CNT_MASK 0x7 813d0407baSopenharmony_ci#define PD_HEADER_ID_SHIFT 9 823d0407baSopenharmony_ci#define PD_HEADER_ID_MASK 0x7 833d0407baSopenharmony_ci#define PD_HEADER_PWR_ROLE BIT(8) 843d0407baSopenharmony_ci#define PD_HEADER_REV_SHIFT 6 853d0407baSopenharmony_ci#define PD_HEADER_REV_MASK 0x3 863d0407baSopenharmony_ci#define PD_HEADER_DATA_ROLE BIT(5) 873d0407baSopenharmony_ci#define PD_HEADER_TYPE_SHIFT 0 883d0407baSopenharmony_ci#define PD_HEADER_TYPE_MASK 0x1f 893d0407baSopenharmony_ci 903d0407baSopenharmony_ci#define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \ 913d0407baSopenharmony_ci ((((type)&PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \ 923d0407baSopenharmony_ci ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | (rev << PD_HEADER_REV_SHIFT) | \ 933d0407baSopenharmony_ci (((id)&PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | (((cnt)&PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \ 943d0407baSopenharmony_ci ((ext_hdr) ? PD_HEADER_EXT_HDR : 0)) 953d0407baSopenharmony_ci 963d0407baSopenharmony_ci#define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \ 973d0407baSopenharmony_ci cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0))) 983d0407baSopenharmony_ci 993d0407baSopenharmony_cistatic inline unsigned int pd_header_cnt(u16 header) 1003d0407baSopenharmony_ci{ 1013d0407baSopenharmony_ci return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK; 1023d0407baSopenharmony_ci} 1033d0407baSopenharmony_ci 1043d0407baSopenharmony_cistatic inline unsigned int pd_header_cnt_le(__le16 header) 1053d0407baSopenharmony_ci{ 1063d0407baSopenharmony_ci return pd_header_cnt(le16_to_cpu(header)); 1073d0407baSopenharmony_ci} 1083d0407baSopenharmony_ci 1093d0407baSopenharmony_cistatic inline unsigned int pd_header_type(u16 header) 1103d0407baSopenharmony_ci{ 1113d0407baSopenharmony_ci return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK; 1123d0407baSopenharmony_ci} 1133d0407baSopenharmony_ci 1143d0407baSopenharmony_cistatic inline unsigned int pd_header_type_le(__le16 header) 1153d0407baSopenharmony_ci{ 1163d0407baSopenharmony_ci return pd_header_type(le16_to_cpu(header)); 1173d0407baSopenharmony_ci} 1183d0407baSopenharmony_ci 1193d0407baSopenharmony_cistatic inline unsigned int pd_header_msgid(u16 header) 1203d0407baSopenharmony_ci{ 1213d0407baSopenharmony_ci return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK; 1223d0407baSopenharmony_ci} 1233d0407baSopenharmony_ci 1243d0407baSopenharmony_cistatic inline unsigned int pd_header_msgid_le(__le16 header) 1253d0407baSopenharmony_ci{ 1263d0407baSopenharmony_ci return pd_header_msgid(le16_to_cpu(header)); 1273d0407baSopenharmony_ci} 1283d0407baSopenharmony_ci 1293d0407baSopenharmony_cistatic inline unsigned int pd_header_rev(u16 header) 1303d0407baSopenharmony_ci{ 1313d0407baSopenharmony_ci return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK; 1323d0407baSopenharmony_ci} 1333d0407baSopenharmony_ci 1343d0407baSopenharmony_cistatic inline unsigned int pd_header_rev_le(__le16 header) 1353d0407baSopenharmony_ci{ 1363d0407baSopenharmony_ci return pd_header_rev(le16_to_cpu(header)); 1373d0407baSopenharmony_ci} 1383d0407baSopenharmony_ci 1393d0407baSopenharmony_ci#define PD_EXT_HDR_CHUNKED BIT(15) 1403d0407baSopenharmony_ci#define PD_EXT_HDR_CHUNK_NUM_SHIFT 11 1413d0407baSopenharmony_ci#define PD_EXT_HDR_CHUNK_NUM_MASK 0xf 1423d0407baSopenharmony_ci#define PD_EXT_HDR_REQ_CHUNK BIT(10) 1433d0407baSopenharmony_ci#define PD_EXT_HDR_DATA_SIZE_SHIFT 0 1443d0407baSopenharmony_ci#define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff 1453d0407baSopenharmony_ci 1463d0407baSopenharmony_ci#define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \ 1473d0407baSopenharmony_ci ((((data_size)&PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \ 1483d0407baSopenharmony_ci ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \ 1493d0407baSopenharmony_ci (((chunk_num)&PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | ((chunked) ? PD_EXT_HDR_CHUNKED : 0)) 1503d0407baSopenharmony_ci 1513d0407baSopenharmony_ci#define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \ 1523d0407baSopenharmony_ci cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked))) 1533d0407baSopenharmony_ci 1543d0407baSopenharmony_cistatic inline unsigned int pd_ext_header_chunk_num(u16 ext_header) 1553d0407baSopenharmony_ci{ 1563d0407baSopenharmony_ci return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) & PD_EXT_HDR_CHUNK_NUM_MASK; 1573d0407baSopenharmony_ci} 1583d0407baSopenharmony_ci 1593d0407baSopenharmony_cistatic inline unsigned int pd_ext_header_data_size(u16 ext_header) 1603d0407baSopenharmony_ci{ 1613d0407baSopenharmony_ci return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) & PD_EXT_HDR_DATA_SIZE_MASK; 1623d0407baSopenharmony_ci} 1633d0407baSopenharmony_ci 1643d0407baSopenharmony_cistatic inline unsigned int pd_ext_header_data_size_le(__le16 ext_header) 1653d0407baSopenharmony_ci{ 1663d0407baSopenharmony_ci return pd_ext_header_data_size(le16_to_cpu(ext_header)); 1673d0407baSopenharmony_ci} 1683d0407baSopenharmony_ci 1693d0407baSopenharmony_ci#define PD_MAX_PAYLOAD 7 1703d0407baSopenharmony_ci#define PD_EXT_MAX_CHUNK_DATA 26 1713d0407baSopenharmony_ci 1723d0407baSopenharmony_ci/** 1733d0407baSopenharmony_ci * struct pd_chunked_ext_message_data - PD chunked extended message data as 1743d0407baSopenharmony_ci * seen on wire 1753d0407baSopenharmony_ci * @header: PD extended message header 1763d0407baSopenharmony_ci * @data: PD extended message data 1773d0407baSopenharmony_ci */ 1783d0407baSopenharmony_cistruct pd_chunked_ext_message_data { 1793d0407baSopenharmony_ci __le16 header; 1803d0407baSopenharmony_ci u8 data[PD_EXT_MAX_CHUNK_DATA]; 1813d0407baSopenharmony_ci} __packed; 1823d0407baSopenharmony_ci 1833d0407baSopenharmony_ci/** 1843d0407baSopenharmony_ci * struct pd_message - PD message as seen on wire 1853d0407baSopenharmony_ci * @header: PD message header 1863d0407baSopenharmony_ci * @payload: PD message payload 1873d0407baSopenharmony_ci * @ext_msg: PD message chunked extended message data 1883d0407baSopenharmony_ci */ 1893d0407baSopenharmony_cistruct pd_message { 1903d0407baSopenharmony_ci __le16 header; 1913d0407baSopenharmony_ci union { 1923d0407baSopenharmony_ci __le32 payload[PD_MAX_PAYLOAD]; 1933d0407baSopenharmony_ci struct pd_chunked_ext_message_data ext_msg; 1943d0407baSopenharmony_ci }; 1953d0407baSopenharmony_ci} __packed; 1963d0407baSopenharmony_ci 1973d0407baSopenharmony_ci/* PDO: Power Data Object */ 1983d0407baSopenharmony_ci#define PDO_MAX_OBJECTS 7 1993d0407baSopenharmony_ci 2003d0407baSopenharmony_cienum pd_pdo_type { 2013d0407baSopenharmony_ci PDO_TYPE_FIXED = 0, 2023d0407baSopenharmony_ci PDO_TYPE_BATT = 1, 2033d0407baSopenharmony_ci PDO_TYPE_VAR = 2, 2043d0407baSopenharmony_ci PDO_TYPE_APDO = 3, 2053d0407baSopenharmony_ci}; 2063d0407baSopenharmony_ci 2073d0407baSopenharmony_ci#define PDO_TYPE_SHIFT 30 2083d0407baSopenharmony_ci#define PDO_TYPE_MASK 0x3 2093d0407baSopenharmony_ci 2103d0407baSopenharmony_ci#define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT) 2113d0407baSopenharmony_ci 2123d0407baSopenharmony_ci#define PDO_VOLT_MASK 0x3ff 2133d0407baSopenharmony_ci#define PDO_CURR_MASK 0x3ff 2143d0407baSopenharmony_ci#define PDO_PWR_MASK 0x3ff 2153d0407baSopenharmony_ci 2163d0407baSopenharmony_ci#define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */ 2173d0407baSopenharmony_ci#define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */ 2183d0407baSopenharmony_ci#define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */ 2193d0407baSopenharmony_ci#define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */ 2203d0407baSopenharmony_ci#define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */ 2213d0407baSopenharmony_ci#define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */ 2223d0407baSopenharmony_ci#define PDO_FIXED_UNCHUNK_EXT BIT(24) /* Unchunked Extended Message supported (Source) */ 2233d0407baSopenharmony_ci#define PDO_FIXED_FRS_CURR_MASK (BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */ 2243d0407baSopenharmony_ci#define PDO_FIXED_FRS_CURR_SHIFT 23 2253d0407baSopenharmony_ci#define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */ 2263d0407baSopenharmony_ci#define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */ 2273d0407baSopenharmony_ci 2283d0407baSopenharmony_ci#define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT) 2293d0407baSopenharmony_ci#define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT) 2303d0407baSopenharmony_ci 2313d0407baSopenharmony_ci#define PDO_FIXED(mv, ma, flags) (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma)) 2323d0407baSopenharmony_ci 2333d0407baSopenharmony_ci#define VSAFE5V 5000 /* mv units */ 2343d0407baSopenharmony_ci 2353d0407baSopenharmony_ci#define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */ 2363d0407baSopenharmony_ci#define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */ 2373d0407baSopenharmony_ci#define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */ 2383d0407baSopenharmony_ci 2393d0407baSopenharmony_ci#define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT) 2403d0407baSopenharmony_ci#define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT) 2413d0407baSopenharmony_ci#define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT) 2423d0407baSopenharmony_ci 2433d0407baSopenharmony_ci#define PDO_BATT(min_mv, max_mv, max_mw) \ 2443d0407baSopenharmony_ci (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw)) 2453d0407baSopenharmony_ci 2463d0407baSopenharmony_ci#define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */ 2473d0407baSopenharmony_ci#define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */ 2483d0407baSopenharmony_ci#define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */ 2493d0407baSopenharmony_ci 2503d0407baSopenharmony_ci#define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT) 2513d0407baSopenharmony_ci#define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT) 2523d0407baSopenharmony_ci#define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT) 2533d0407baSopenharmony_ci 2543d0407baSopenharmony_ci#define PDO_VAR(min_mv, max_mv, max_ma) \ 2553d0407baSopenharmony_ci (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma)) 2563d0407baSopenharmony_ci 2573d0407baSopenharmony_cienum pd_apdo_type { 2583d0407baSopenharmony_ci APDO_TYPE_PPS = 0, 2593d0407baSopenharmony_ci}; 2603d0407baSopenharmony_ci 2613d0407baSopenharmony_ci#define PDO_APDO_TYPE_SHIFT 28 /* Only valid value currently is 0x0 - PPS */ 2623d0407baSopenharmony_ci#define PDO_APDO_TYPE_MASK 0x3 2633d0407baSopenharmony_ci 2643d0407baSopenharmony_ci#define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT) 2653d0407baSopenharmony_ci 2663d0407baSopenharmony_ci#define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */ 2673d0407baSopenharmony_ci#define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */ 2683d0407baSopenharmony_ci#define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */ 2693d0407baSopenharmony_ci 2703d0407baSopenharmony_ci#define PDO_PPS_APDO_VOLT_MASK 0xff 2713d0407baSopenharmony_ci#define PDO_PPS_APDO_CURR_MASK 0x7f 2723d0407baSopenharmony_ci 2733d0407baSopenharmony_ci#define PDO_PPS_APDO_MIN_VOLT(mv) ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT) 2743d0407baSopenharmony_ci#define PDO_PPS_APDO_MAX_VOLT(mv) ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT) 2753d0407baSopenharmony_ci#define PDO_PPS_APDO_MAX_CURR(ma) ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT) 2763d0407baSopenharmony_ci 2773d0407baSopenharmony_ci#define PDO_PPS_APDO(min_mv, max_mv, max_ma) \ 2783d0407baSopenharmony_ci (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | PDO_PPS_APDO_MIN_VOLT(min_mv) | \ 2793d0407baSopenharmony_ci PDO_PPS_APDO_MAX_VOLT(max_mv) | PDO_PPS_APDO_MAX_CURR(max_ma)) 2803d0407baSopenharmony_ci 2813d0407baSopenharmony_cistatic inline enum pd_pdo_type pdo_type(u32 pdo) 2823d0407baSopenharmony_ci{ 2833d0407baSopenharmony_ci return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK; 2843d0407baSopenharmony_ci} 2853d0407baSopenharmony_ci 2863d0407baSopenharmony_cistatic inline unsigned int pdo_fixed_voltage(u32 pdo) 2873d0407baSopenharmony_ci{ 2883d0407baSopenharmony_ci return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 0x32; 2893d0407baSopenharmony_ci} 2903d0407baSopenharmony_ci 2913d0407baSopenharmony_cistatic inline unsigned int pdo_min_voltage(u32 pdo) 2923d0407baSopenharmony_ci{ 2933d0407baSopenharmony_ci return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 0x32; 2943d0407baSopenharmony_ci} 2953d0407baSopenharmony_ci 2963d0407baSopenharmony_cistatic inline unsigned int pdo_max_voltage(u32 pdo) 2973d0407baSopenharmony_ci{ 2983d0407baSopenharmony_ci return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 0x32; 2993d0407baSopenharmony_ci} 3003d0407baSopenharmony_ci 3013d0407baSopenharmony_cistatic inline unsigned int pdo_max_current(u32 pdo) 3023d0407baSopenharmony_ci{ 3033d0407baSopenharmony_ci return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 0xa; 3043d0407baSopenharmony_ci} 3053d0407baSopenharmony_ci 3063d0407baSopenharmony_cistatic inline unsigned int pdo_max_power(u32 pdo) 3073d0407baSopenharmony_ci{ 3083d0407baSopenharmony_ci return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 0xfa; 3093d0407baSopenharmony_ci} 3103d0407baSopenharmony_ci 3113d0407baSopenharmony_cistatic inline enum pd_apdo_type pdo_apdo_type(u32 pdo) 3123d0407baSopenharmony_ci{ 3133d0407baSopenharmony_ci return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK; 3143d0407baSopenharmony_ci} 3153d0407baSopenharmony_ci 3163d0407baSopenharmony_cistatic inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo) 3173d0407baSopenharmony_ci{ 3183d0407baSopenharmony_ci return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) & PDO_PPS_APDO_VOLT_MASK) * 0x64; 3193d0407baSopenharmony_ci} 3203d0407baSopenharmony_ci 3213d0407baSopenharmony_cistatic inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo) 3223d0407baSopenharmony_ci{ 3233d0407baSopenharmony_ci return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) & PDO_PPS_APDO_VOLT_MASK) * 0x64; 3243d0407baSopenharmony_ci} 3253d0407baSopenharmony_ci 3263d0407baSopenharmony_cistatic inline unsigned int pdo_pps_apdo_max_current(u32 pdo) 3273d0407baSopenharmony_ci{ 3283d0407baSopenharmony_ci return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) & PDO_PPS_APDO_CURR_MASK) * 0x32; 3293d0407baSopenharmony_ci} 3303d0407baSopenharmony_ci 3313d0407baSopenharmony_ci/* RDO: Request Data Object */ 3323d0407baSopenharmony_ci#define RDO_OBJ_POS_SHIFT 28 3333d0407baSopenharmony_ci#define RDO_OBJ_POS_MASK 0x7 3343d0407baSopenharmony_ci#define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */ 3353d0407baSopenharmony_ci#define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */ 3363d0407baSopenharmony_ci#define RDO_USB_COMM BIT(25) /* USB communications capable */ 3373d0407baSopenharmony_ci#define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */ 3383d0407baSopenharmony_ci 3393d0407baSopenharmony_ci#define RDO_PWR_MASK 0x3ff 3403d0407baSopenharmony_ci#define RDO_CURR_MASK 0x3ff 3413d0407baSopenharmony_ci 3423d0407baSopenharmony_ci#define RDO_FIXED_OP_CURR_SHIFT 10 3433d0407baSopenharmony_ci#define RDO_FIXED_MAX_CURR_SHIFT 0 3443d0407baSopenharmony_ci 3453d0407baSopenharmony_ci#define RDO_OBJ(idx) (((idx)&RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT) 3463d0407baSopenharmony_ci 3473d0407baSopenharmony_ci#define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT) 3483d0407baSopenharmony_ci#define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT) 3493d0407baSopenharmony_ci 3503d0407baSopenharmony_ci#define RDO_FIXED(idx, op_ma, max_ma, flags) \ 3513d0407baSopenharmony_ci (RDO_OBJ(idx) | (flags) | PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma)) 3523d0407baSopenharmony_ci 3533d0407baSopenharmony_ci#define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */ 3543d0407baSopenharmony_ci#define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */ 3553d0407baSopenharmony_ci 3563d0407baSopenharmony_ci#define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT) 3573d0407baSopenharmony_ci#define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT) 3583d0407baSopenharmony_ci 3593d0407baSopenharmony_ci#define RDO_BATT(idx, op_mw, max_mw, flags) (RDO_OBJ(idx) | (flags) | RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw)) 3603d0407baSopenharmony_ci 3613d0407baSopenharmony_ci#define RDO_PROG_VOLT_MASK 0x7ff 3623d0407baSopenharmony_ci#define RDO_PROG_CURR_MASK 0x7f 3633d0407baSopenharmony_ci 3643d0407baSopenharmony_ci#define RDO_PROG_VOLT_SHIFT 9 3653d0407baSopenharmony_ci#define RDO_PROG_CURR_SHIFT 0 3663d0407baSopenharmony_ci 3673d0407baSopenharmony_ci#define RDO_PROG_VOLT_MV_STEP 20 3683d0407baSopenharmony_ci#define RDO_PROG_CURR_MA_STEP 50 3693d0407baSopenharmony_ci 3703d0407baSopenharmony_ci#define PDO_PROG_OUT_VOLT(mv) ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT) 3713d0407baSopenharmony_ci#define PDO_PROG_OP_CURR(ma) ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT) 3723d0407baSopenharmony_ci 3733d0407baSopenharmony_ci#define RDO_PROG(idx, out_mv, op_ma, flags) \ 3743d0407baSopenharmony_ci (RDO_OBJ(idx) | (flags) | PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma)) 3753d0407baSopenharmony_ci 3763d0407baSopenharmony_cistatic inline unsigned int rdo_index(u32 rdo) 3773d0407baSopenharmony_ci{ 3783d0407baSopenharmony_ci return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK; 3793d0407baSopenharmony_ci} 3803d0407baSopenharmony_ci 3813d0407baSopenharmony_cistatic inline unsigned int rdo_op_current(u32 rdo) 3823d0407baSopenharmony_ci{ 3833d0407baSopenharmony_ci return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 0xa; 3843d0407baSopenharmony_ci} 3853d0407baSopenharmony_ci 3863d0407baSopenharmony_cistatic inline unsigned int rdo_max_current(u32 rdo) 3873d0407baSopenharmony_ci{ 3883d0407baSopenharmony_ci return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) & RDO_CURR_MASK) * 0xa; 3893d0407baSopenharmony_ci} 3903d0407baSopenharmony_ci 3913d0407baSopenharmony_cistatic inline unsigned int rdo_op_power(u32 rdo) 3923d0407baSopenharmony_ci{ 3933d0407baSopenharmony_ci return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 0xfa; 3943d0407baSopenharmony_ci} 3953d0407baSopenharmony_ci 3963d0407baSopenharmony_cistatic inline unsigned int rdo_max_power(u32 rdo) 3973d0407baSopenharmony_ci{ 3983d0407baSopenharmony_ci return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 0xfa; 3993d0407baSopenharmony_ci} 4003d0407baSopenharmony_ci 4013d0407baSopenharmony_ci/* Enter_USB Data Object */ 4023d0407baSopenharmony_ci#define EUDO_USB_MODE_MASK GENMASK(30, 28) 4033d0407baSopenharmony_ci#define EUDO_USB_MODE_SHIFT 28 4043d0407baSopenharmony_ci#define EUDO_USB_MODE_USB2 0 4053d0407baSopenharmony_ci#define EUDO_USB_MODE_USB3 1 4063d0407baSopenharmony_ci#define EUDO_USB_MODE_USB4 2 4073d0407baSopenharmony_ci#define EUDO_USB4_DRD BIT(26) 4083d0407baSopenharmony_ci#define EUDO_USB3_DRD BIT(25) 4093d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_MASK GENMASK(23, 21) 4103d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_SHIFT 21 4113d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_USB2 0 4123d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_USB3_GEN1 1 4133d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_USB4_GEN2 2 4143d0407baSopenharmony_ci#define EUDO_CABLE_SPEED_USB4_GEN3 3 4153d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_MASK GENMASK(20, 19) 4163d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_SHIFT 19 4173d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_PASSIVE 0 4183d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_RE_TIMER 1 4193d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_RE_DRIVER 2 4203d0407baSopenharmony_ci#define EUDO_CABLE_TYPE_OPTICAL 3 4213d0407baSopenharmony_ci#define EUDO_CABLE_CURRENT_MASK GENMASK(18, 17) 4223d0407baSopenharmony_ci#define EUDO_CABLE_CURRENT_SHIFT 17 4233d0407baSopenharmony_ci#define EUDO_CABLE_CURRENT_NOTSUPP 0 4243d0407baSopenharmony_ci#define EUDO_CABLE_CURRENT_3A 2 4253d0407baSopenharmony_ci#define EUDO_CABLE_CURRENT_5A 3 4263d0407baSopenharmony_ci#define EUDO_PCIE_SUPPORT BIT(16) 4273d0407baSopenharmony_ci#define EUDO_DP_SUPPORT BIT(15) 4283d0407baSopenharmony_ci#define EUDO_TBT_SUPPORT BIT(14) 4293d0407baSopenharmony_ci#define EUDO_HOST_PRESENT BIT(13) 4303d0407baSopenharmony_ci 4313d0407baSopenharmony_ci/* USB PD timers and counters */ 4323d0407baSopenharmony_ci#define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */ 4333d0407baSopenharmony_ci#define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */ 4343d0407baSopenharmony_ci#define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */ 4353d0407baSopenharmony_ci#define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */ 4363d0407baSopenharmony_ci#define PD_T_RECEIVER_RESPONSE 15 /* 15ms max */ 4373d0407baSopenharmony_ci#define PD_T_SOURCE_ACTIVITY 45 4383d0407baSopenharmony_ci#define PD_T_SINK_ACTIVITY 135 4393d0407baSopenharmony_ci#define PD_T_SINK_WAIT_CAP 310 /* 310 - 620 ms */ 4403d0407baSopenharmony_ci#define PD_T_PS_TRANSITION 500 4413d0407baSopenharmony_ci#define PD_T_SRC_TRANSITION 35 4423d0407baSopenharmony_ci#define PD_T_DRP_SNK 40 4433d0407baSopenharmony_ci#define PD_T_DRP_SRC 30 4443d0407baSopenharmony_ci#define PD_T_PS_SOURCE_OFF 920 4453d0407baSopenharmony_ci#define PD_T_PS_SOURCE_ON 480 4463d0407baSopenharmony_ci#define PD_T_PS_SOURCE_ON_PRS 450 /* 390 - 480ms */ 4473d0407baSopenharmony_ci#define PD_T_PS_HARD_RESET 30 4483d0407baSopenharmony_ci#define PD_T_SRC_RECOVER 760 4493d0407baSopenharmony_ci#define PD_T_SRC_RECOVER_MAX 1000 4503d0407baSopenharmony_ci#define PD_T_SRC_TURN_ON 275 4513d0407baSopenharmony_ci#define PD_T_SAFE_0V 650 4523d0407baSopenharmony_ci#define PD_T_VCONN_SOURCE_ON 100 4533d0407baSopenharmony_ci#define PD_T_SINK_REQUEST 100 /* 100 ms minimum */ 4543d0407baSopenharmony_ci#define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */ 4553d0407baSopenharmony_ci#define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */ 4563d0407baSopenharmony_ci#define PD_T_NEWSRC 250 /* Maximum of 275ms */ 4573d0407baSopenharmony_ci#define PD_T_SWAP_SRC_START 20 /* Minimum of 20ms */ 4583d0407baSopenharmony_ci#define PD_T_BIST_CONT_MODE 50 /* 30 - 60 ms */ 4593d0407baSopenharmony_ci#define PD_T_SINK_TX 16 /* 16 - 20 ms */ 4603d0407baSopenharmony_ci#define PD_T_CHUNK_NOT_SUPP 42 /* 40 - 50 ms */ 4613d0407baSopenharmony_ci 4623d0407baSopenharmony_ci#define PD_T_DRP_TRY 100 /* 75 - 150 ms */ 4633d0407baSopenharmony_ci#define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */ 4643d0407baSopenharmony_ci 4653d0407baSopenharmony_ci#define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */ 4663d0407baSopenharmony_ci#define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */ 4673d0407baSopenharmony_ci#define PD_T_TRY_CC_DEBOUNCE 15 /* 10 - 20 ms */ 4683d0407baSopenharmony_ci 4693d0407baSopenharmony_ci#define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP) 4703d0407baSopenharmony_ci#define PD_N_HARD_RESET_COUNT 2 4713d0407baSopenharmony_ci 4723d0407baSopenharmony_ci#define PD_P_SNK_STDBY_MW 2500 /* 2500 mW */ 4733d0407baSopenharmony_ci 4743d0407baSopenharmony_ci#endif /* __LINUX_USB_PD_H */ 475