Line data    Source code

       1           0 : /*
       2             :  * Copyright 2022 The Chromium OS Authors
       3             :  * SPDX-License-Identifier: Apache-2.0
       4             :  *
       5             :  * This is based on Linux, documentation:
       6             :  *   https://github.com/torvalds/linux/blob/v5.19/include/dt-bindings/usb/pd.h
       7             :  */
       8             : #ifndef ZEPHYR_INCLUDE_DT_BINDINGS_USBC_PD_H_
       9             : #define ZEPHYR_INCLUDE_DT_BINDINGS_USBC_PD_H_
      10             : 
      11             : /* Power delivery Power Data Object definitions */
      12           0 : #define PDO_TYPE_FIXED          0
      13           0 : #define PDO_TYPE_BATT           1
      14           0 : #define PDO_TYPE_VAR            2
      15           0 : #define PDO_TYPE_APDO           3
      16             : 
      17           0 : #define PDO_TYPE_SHIFT          30
      18           0 : #define PDO_TYPE_MASK           0x3
      19             : 
      20           0 : #define PDO_TYPE(t)     ((t) << PDO_TYPE_SHIFT)
      21             : 
      22           0 : #define PDO_VOLT_MASK           0x3ff
      23           0 : #define PDO_CURR_MASK           0x3ff
      24           0 : #define PDO_PWR_MASK            0x3ff
      25             : 
      26           0 : #define PDO_FIXED_DUAL_ROLE     (1 << 29) /* Power role swap supported */
      27           0 : #define PDO_FIXED_SUSPEND       (1 << 28) /* USB Suspend supported (Source) */
      28           0 : #define PDO_FIXED_HIGHER_CAP    (1 << 28) /* Requires more than vSafe5V (Sink) */
      29           0 : #define PDO_FIXED_EXTPOWER      (1 << 27) /* Externally powered */
      30           0 : #define PDO_FIXED_USB_COMM      (1 << 26) /* USB communications capable */
      31           0 : #define PDO_FIXED_DATA_SWAP     (1 << 25) /* Data role swap supported */
      32           0 : #define PDO_FIXED_VOLT_SHIFT    10      /* 50mV units */
      33           0 : #define PDO_FIXED_CURR_SHIFT    0       /* 10mA units */
      34             : 
      35           0 : #define PDO_FIXED_VOLT(mv)      ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
      36           0 : #define PDO_FIXED_CURR(ma)      ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
      37             : 
      38           0 : #define PDO_FIXED(mv, ma, flags)                        \
      39             :         (PDO_TYPE(PDO_TYPE_FIXED) | (flags) |           \
      40             :          PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
      41             : 
      42           0 : #define VSAFE5V 5000 /* mv units */
      43             : 
      44           0 : #define PDO_BATT_MAX_VOLT_SHIFT 20      /* 50mV units */
      45           0 : #define PDO_BATT_MIN_VOLT_SHIFT 10      /* 50mV units */
      46           0 : #define PDO_BATT_MAX_PWR_SHIFT  0       /* 250mW units */
      47             : 
      48           0 : #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
      49           0 : #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
      50           0 : #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
      51             : 
      52           0 : #define PDO_BATT(min_mv, max_mv, max_mw)                        \
      53             :         (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) |  \
      54             :          PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
      55             : 
      56           0 : #define PDO_VAR_MAX_VOLT_SHIFT  20      /* 50mV units */
      57           0 : #define PDO_VAR_MIN_VOLT_SHIFT  10      /* 50mV units */
      58           0 : #define PDO_VAR_MAX_CURR_SHIFT  0       /* 10mA units */
      59             : 
      60           0 : #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
      61           0 : #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
      62           0 : #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
      63             : 
      64           0 : #define PDO_VAR(min_mv, max_mv, max_ma)                         \
      65             :         (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) |    \
      66             :          PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
      67             : 
      68           0 : #define APDO_TYPE_PPS           0
      69             : 
      70           0 : #define PDO_APDO_TYPE_SHIFT     28      /* Only valid value currently is 0x0 - PPS */
      71           0 : #define PDO_APDO_TYPE_MASK      0x3
      72             : 
      73           0 : #define PDO_APDO_TYPE(t)        ((t) << PDO_APDO_TYPE_SHIFT)
      74             : 
      75           0 : #define PDO_PPS_APDO_MAX_VOLT_SHIFT     17      /* 100mV units */
      76           0 : #define PDO_PPS_APDO_MIN_VOLT_SHIFT     8       /* 100mV units */
      77           0 : #define PDO_PPS_APDO_MAX_CURR_SHIFT     0       /* 50mA units */
      78             : 
      79           0 : #define PDO_PPS_APDO_VOLT_MASK  0xff
      80           0 : #define PDO_PPS_APDO_CURR_MASK  0x7f
      81             : 
      82           0 : #define PDO_PPS_APDO_MIN_VOLT(mv)       \
      83             :         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
      84           0 : #define PDO_PPS_APDO_MAX_VOLT(mv)       \
      85             :         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
      86           0 : #define PDO_PPS_APDO_MAX_CURR(ma)       \
      87             :         ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
      88             : 
      89           0 : #define PDO_PPS_APDO(min_mv, max_mv, max_ma)                                    \
      90             :         (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) |               \
      91             :          PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) |        \
      92             :          PDO_PPS_APDO_MAX_CURR(max_ma))
      93             : 
      94             : #endif /* ZEPHYR_INCLUDE_DT_BINDINGS_USBC_PD_H_ */