[PATCH net-next v3 01/47] dt-bindings: phy: Add Lynx 10G phy binding
Rob Herring
robh at kernel.org
Wed Jul 20 15:17:04 PDT 2022
On Fri, Jul 15, 2022 at 05:59:08PM -0400, Sean Anderson wrote:
> This adds a binding for the SerDes module found on QorIQ processors. The
> phy reference has two cells, one for the first lane and one for the
> last. This should allow for good support of multi-lane protocols when
> (if) they are added. There is no protocol option, because the driver is
> designed to be able to completely reconfigure lanes at runtime.
> Generally, the phy consumer can select the appropriate protocol using
> set_mode. For the most part there is only one protocol controller
> (consumer) per lane/protocol combination. The exception to this is the
> B4860 processor, which has some lanes which can be connected to
> multiple MACs. For that processor, I anticipate the easiest way to
> resolve this will be to add an additional cell with a "protocol
> controller instance" property.
>
> Each serdes has a unique set of supported protocols (and lanes). The
> support matrix is configured in the device tree. The format of each
> PCCR (protocol configuration register) is modeled. Although the general
> format is typically the same across different SoCs, the specific
> supported protocols (and the values necessary to select them) are
> particular to individual SerDes. A nested structure is used to reduce
> duplication of data.
>
> There are two PLLs, each of which can be used as the master clock for
> each lane. Each PLL has its own reference. For the moment they are
> required, because it simplifies the driver implementation. Absent
> reference clocks can be modeled by a fixed-clock with a rate of 0.
>
> Signed-off-by: Sean Anderson <sean.anderson at seco.com>
> ---
>
> Changes in v3:
> - Manually expand yaml references
> - Add mode configuration to device tree
>
> Changes in v2:
> - Rename to fsl,lynx-10g.yaml
> - Refer to the device in the documentation, rather than the binding
> - Move compatible first
> - Document phy cells in the description
> - Allow a value of 1 for phy-cells. This allows for compatibility with
> the similar (but according to Ioana Ciornei different enough) lynx-28g
> binding.
> - Remove minItems
> - Use list for clock-names
> - Fix example binding having too many cells in regs
> - Add #clock-cells. This will allow using assigned-clocks* to configure
> the PLLs.
> - Document the structure of the compatible strings
>
> .../devicetree/bindings/phy/fsl,lynx-10g.yaml | 311 ++++++++++++++++++
> 1 file changed, 311 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/phy/fsl,lynx-10g.yaml
>
> diff --git a/Documentation/devicetree/bindings/phy/fsl,lynx-10g.yaml b/Documentation/devicetree/bindings/phy/fsl,lynx-10g.yaml
> new file mode 100644
> index 000000000000..a2c37225bb67
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/fsl,lynx-10g.yaml
> @@ -0,0 +1,311 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/phy/fsl,lynx-10g.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP Lynx 10G SerDes
> +
> +maintainers:
> + - Sean Anderson <sean.anderson at seco.com>
> +
> +description: |
> + These Lynx "SerDes" devices are found in NXP's QorIQ line of processors. The
> + SerDes provides up to eight lanes. Each lane may be configured individually,
> + or may be combined with adjacent lanes for a multi-lane protocol. The SerDes
> + supports a variety of protocols, including up to 10G Ethernet, PCIe, SATA, and
> + others. The specific protocols supported for each lane depend on the
> + particular SoC.
> +
> +definitions:
$defs:
> + fsl,cfg:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + minimum: 1
> + description: |
> + The configuration value to program into the field.
What field?
> +
> + fsl,first-lane:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + minimum: 0
> + maximum: 7
> + description: |
> + The first lane in the group configured by fsl,cfg. This lane will have
> + the FIRST_LANE bit set in GCR0. The reset direction will also be set
> + based on whether this property is less than or greater than
> + fsl,last-lane.
> +
> + fsl,last-lane:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + minimum: 0
> + maximum: 7
> + description: |
> + The last lane configured by fsl,cfg. If this property is absent,
> + then it will default to the value of fsl,first-lane.
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - fsl,ls1046a-serdes
> + - fsl,ls1088a-serdes
> + - const: fsl,lynx-10g
> +
> + "#clock-cells":
> + const: 1
> + description: |
> + The cell contains the index of the PLL, starting from 0. Note that when
> + assigning a rate to a PLL, the PLLs' rates are divided by 1000 to avoid
> + overflow. A rate of 5000000 corresponds to 5GHz.
> +
> + "#phy-cells":
> + minimum: 1
> + maximum: 2
> + description: |
> + The cells contain the following arguments:
> + - The first lane in the group. Lanes are numbered based on the register
> + offsets, not the I/O ports. This corresponds to the letter-based ("Lane
> + A") naming scheme, and not the number-based ("Lane 0") naming scheme. On
> + most SoCs, "Lane A" is "Lane 0", but not always.
> + - Last lane. For single-lane protocols, this should be the same as the
> + first lane.
Perhaps a single cell with a lane mask would be simpler.
> + If no lanes in a SerDes can be grouped, then #phy-cells may be 1, and the
> + first cell will specify the only lane in the group.
It is generally easier to have a fixed number of cells.
> +
> + clocks:
> + maxItems: 2
> + description: |
> + Clock for each PLL reference clock input.
> +
> + clock-names:
> + minItems: 2
> + maxItems: 2
> + items:
> + enum:
> + - ref0
> + - ref1
> +
> + reg:
> + maxItems: 1
> +
> +patternProperties:
> + '^pccr-':
> + type: object
> +
> + description: |
> + One of the protocol configuration registers (PCCRs). These contains
> + several fields, each of which mux a particular protocol onto a particular
> + lane.
> +
> + properties:
> + fsl,pccr:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: |
> + The index of the PCCR. This is the same as the register name suffix.
> + For example, a node for PCCRB would use a value of '0xb' for an
> + offset of 0x22C (0x200 + 4 * 0xb).
> +
> + patternProperties:
> + '^(q?sgmii|xfi|pcie|sata)-':
> + type: object
> +
> + description: |
> + A configuration field within a PCCR. Each field configures one
> + protocol controller. The value of the field determines the lanes the
> + controller is connected to, if any.
> +
> + properties:
> + fsl,index:
indexes are generally a red flag in binding. What is the index, how does
it correspond to the h/w and why do you need it. If we do end up needing
it, 'reg' is generally how we address some component.
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: |
> + The index of the field. This corresponds to the suffix in the
What field?
> + documentation. For example, PEXa would be 0, PEXb 1, etc.
> + Generally, higher fields occupy lower bits.
> +
> + If there are any subnodes present, they will be preferred over
> + fsl,cfg et. al.
> +
> + fsl,cfg:
> + $ref: "#/definitions/fsl,cfg"
> +
> + fsl,first-lane:
> + $ref: "#/definitions/fsl,first-lane"
> +
> + fsl,last-lane:
> + $ref: "#/definitions/fsl,last-lane"
Why do you have lane assignments here and in the phy cells?
> +
> + fsl,proto:
> + $ref: /schemas/types.yaml#/definitions/string
> + enum:
> + - sgmii
> + - sgmii25
> + - qsgmii
> + - xfi
> + - pcie
> + - sata
We have standard phy modes already for at least most of these types.
Generally the mode is set in the phy cells.
> + description: |
> + Indicates the basic group protocols supported by this field.
> + Individual protocols are selected by configuring the protocol
> + controller.
> +
> + - sgmii: 1000BASE-X, SGMII, and 1000BASE-KX (depending on the
> + SoC)
> + - sgmii25: 2500BASE-X, 1000BASE-X, SGMII, and 1000BASE-KX
> + (depending on the SoC)
> + - qsgmii: QSGMII
> + - xfi: 10GBASE-R and 10GBASE-KR (depending on the SoC)
> + - pcie: PCIe
> + - sata: SATA
> +
> + patternProperties:
> + '^cfg-':
> + type: object
> +
> + description: |
> + A single field may have multiple values which, when programmed,
> + connect the protocol controller to different lanes. If this is the
> + case, multiple sub-nodes may be provided, each describing a
> + single muxing.
> +
> + properties:
> + fsl,cfg:
> + $ref: "#/definitions/fsl,cfg"
> +
> + fsl,first-lane:
> + $ref: "#/definitions/fsl,first-lane"
> +
> + fsl,last-lane:
> + $ref: "#/definitions/fsl,last-lane"
> +
> + required:
> + - fsl,cfg
> + - fsl,first-lane
> +
> + dependencies:
> + fsl,last-lane:
> + - fsl,first-lane
> +
> + additionalProperties: false
> +
> + required:
> + - fsl,index
> + - fsl,proto
> +
> + dependencies:
> + fsl,last-lane:
> + - fsl,first-lane
> + fsl,cfg:
> + - fsl,first-lane
> + fsl,first-lane:
> + - fsl,cfg
> +
> + # I would like to require either a config subnode or the config
> + # properties (and not both), but from what I can tell that can't be
> + # expressed in json schema. In particular, it is not possible to
> + # require a pattern property.
Indeed, it is not. There's been some proposals.
> +
> + additionalProperties: false
> +
> + required:
> + - fsl,pccr
> +
> + additionalProperties: false
> +
> +required:
> + - "#clock-cells"
> + - "#phy-cells"
> + - compatible
> + - clocks
> + - clock-names
> + - reg
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + serdes1: phy at 1ea0000 {
> + #clock-cells = <1>;
> + #phy-cells = <2>;
> + compatible = "fsl,ls1088a-serdes", "fsl,lynx-10g";
> + reg = <0x1ea0000 0x2000>;
> + clocks = <&clk_100mhz>, <&clk_156_mhz>;
> + clock-names = "ref0", "ref1";
> + assigned-clocks = <&serdes1 0>;
> + assigned-clock-rates = <5000000>;
> +
> + pccr-8 {
> + fsl,pccr = <0x8>;
> +
> + sgmii-0 {
> + fsl,index = <0>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <3>;
> + fsl,proto = "sgmii";
> + };
> +
> + sgmii-1 {
> + fsl,index = <1>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <2>;
> + fsl,proto = "sgmii";
> + };
> +
> + sgmii-2 {
> + fsl,index = <2>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <1>;
> + fsl,proto = "sgmii25";
> + };
> +
> + sgmii-3 {
> + fsl,index = <3>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <0>;
> + fsl,proto = "sgmii25";
> + };
> + };
> +
> + pccr-9 {
> + fsl,pccr = <0x9>;
> +
> + qsgmii-0 {
> + fsl,index = <0>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <3>;
> + fsl,proto = "qsgmii";
> + };
> +
> + qsgmii-1 {
> + fsl,index = <1>;
> + fsl,proto = "qsgmii";
> +
> + cfg-1 {
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <2>;
> + };
> +
> + cfg-2 {
> + fsl,cfg = <0x2>;
> + fsl,first-lane = <0>;
> + };
> + };
> + };
> +
> + pccr-b {
> + fsl,pccr = <0xb>;
> +
> + xfi-0 {
> + fsl,index = <0>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <1>;
> + fsl,proto = "xfi";
> + };
> +
> + xfi-1 {
> + fsl,index = <1>;
> + fsl,cfg = <0x1>;
> + fsl,first-lane = <0>;
> + fsl,proto = "xfi";
> + };
> + };
> + };
Other than lane assignments and modes, I don't really understand what
you are trying to do. It all looks too complex and I don't see any other
phy bindings needing something this complex.
Rob
More information about the linux-phy
mailing list