<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Family dpll netlink specification — The Linux Kernel documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=3918102e" />
<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Family ethtool netlink specification" href="ethtool.html" />
<link rel="prev" title="Family devlink netlink specification" href="devlink.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/logo.svg" alt="Logo of The Linux Kernel"/>
</a></p>
<h1 class="logo"><a href="../../index.html">The Linux Kernel</a></h1>
<p class="blurb">6.18.50</p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<p>
<h3 class="kernel-toc-contents">Contents</h3>
<input type="checkbox" class="kernel-toc-toggle" id = "kernel-toc-toggle" checked>
<label class="kernel-toc-title" for="kernel-toc-toggle"></label>
<div class="kerneltoc" id="kerneltoc">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../process/development-process.html">Development process</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/submitting-patches.html">Submitting patches</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/code-of-conduct.html">Code of conduct</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../maintainer/index.html">Maintainer handbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../process/index.html">All development-process docs</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../core-api/index.html">Core API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../driver-api/index.html">Driver APIs</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../subsystem-apis.html">Subsystems</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#core-subsystems">Core subsystems</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#human-interfaces">Human interfaces</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../subsystem-apis.html#networking-interfaces">Networking interfaces</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../networking/index.html">Networking</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../netlabel/index.html">NetLabel</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../infiniband/index.html">InfiniBand</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../isdn/index.html">ISDN</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../mhi/index.html">MHI</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#storage-interfaces">Storage interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../subsystem-apis.html#other-subsystems">Other subsystems</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../locking/index.html">Locking</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../process/license-rules.html">Licensing rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../doc-guide/index.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev-tools/index.html">Development tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev-tools/testing-overview.html">Testing guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../kernel-hacking/index.html">Hacking guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../trace/index.html">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../fault-injection/index.html">Fault injection</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../livepatch/index.html">Livepatching</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rust/index.html">Rust</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../admin-guide/index.html">Administration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../kbuild/index.html">Build system</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin-guide/reporting-issues.html">Reporting issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tools/index.html">Userspace tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../userspace-api/index.html">Userspace API</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../firmware-guide/index.html">Firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../devicetree/index.html">Firmware and Devicetree</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../arch/index.html">CPU architectures</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../staging/index.html">Unsorted documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../translations/index.html">Translations</a></li>
</ul>
</div>
<script type="text/javascript"> <!--
var sbar = document.getElementsByClassName("sphinxsidebar")[0];
let currents = document.getElementsByClassName("current")
if (currents.length) {
sbar.scrollTop = currents[currents.length - 1].offsetTop;
}
--> </script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/netlink/specs/dpll.yaml.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="family-dpll-netlink-specification">
<span id="netlink-dpll"></span><h1><a class="toc-backref" href="#id9" role="doc-backlink">Family <code class="docutils literal notranslate"><span class="pre">dpll</span></code> netlink specification</a><a class="headerlink" href="#family-dpll-netlink-specification" title="Link to this heading">¶</a></h1>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#family-dpll-netlink-specification" id="id9">Family <code class="docutils literal notranslate"><span class="pre">dpll</span></code> netlink specification</a></p>
<ul>
<li><p><a class="reference internal" href="#summary" id="id10">Summary</a></p></li>
<li><p><a class="reference internal" href="#operations" id="id11">Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#device-id-get" id="id12">device-id-get</a></p></li>
<li><p><a class="reference internal" href="#device-get" id="id13">device-get</a></p></li>
<li><p><a class="reference internal" href="#device-set" id="id14">device-set</a></p></li>
<li><p><a class="reference internal" href="#device-create-ntf" id="id15">device-create-ntf</a></p></li>
<li><p><a class="reference internal" href="#device-delete-ntf" id="id16">device-delete-ntf</a></p></li>
<li><p><a class="reference internal" href="#device-change-ntf" id="id17">device-change-ntf</a></p></li>
<li><p><a class="reference internal" href="#pin-id-get" id="id18">pin-id-get</a></p></li>
<li><p><a class="reference internal" href="#pin-get" id="id19">pin-get</a></p></li>
<li><p><a class="reference internal" href="#pin-set" id="id20">pin-set</a></p></li>
<li><p><a class="reference internal" href="#pin-create-ntf" id="id21">pin-create-ntf</a></p></li>
<li><p><a class="reference internal" href="#pin-delete-ntf" id="id22">pin-delete-ntf</a></p></li>
<li><p><a class="reference internal" href="#pin-change-ntf" id="id23">pin-change-ntf</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#multicast-groups" id="id24">Multicast groups</a></p></li>
<li><p><a class="reference internal" href="#definitions" id="id25">Definitions</a></p>
<ul>
<li><p><a class="reference internal" href="#mode" id="id26">mode</a></p></li>
<li><p><a class="reference internal" href="#lock-status" id="id27">lock-status</a></p></li>
<li><p><a class="reference internal" href="#lock-status-error" id="id28">lock-status-error</a></p></li>
<li><p><a class="reference internal" href="#clock-quality-level" id="id29">clock-quality-level</a></p></li>
<li><p><a class="reference internal" href="#temp-divider" id="id30">temp-divider</a></p></li>
<li><p><a class="reference internal" href="#type" id="id31">type</a></p></li>
<li><p><a class="reference internal" href="#pin-type" id="id32">pin-type</a></p></li>
<li><p><a class="reference internal" href="#pin-direction" id="id33">pin-direction</a></p></li>
<li><p><a class="reference internal" href="#pin-frequency-1-hz" id="id34">pin-frequency-1-hz</a></p></li>
<li><p><a class="reference internal" href="#pin-frequency-10-khz" id="id35">pin-frequency-10-khz</a></p></li>
<li><p><a class="reference internal" href="#pin-frequency-77-5-khz" id="id36">pin-frequency-77-5-khz</a></p></li>
<li><p><a class="reference internal" href="#pin-frequency-10-mhz" id="id37">pin-frequency-10-mhz</a></p></li>
<li><p><a class="reference internal" href="#pin-state" id="id38">pin-state</a></p></li>
<li><p><a class="reference internal" href="#pin-capabilities" id="id39">pin-capabilities</a></p></li>
<li><p><a class="reference internal" href="#phase-offset-divider" id="id40">phase-offset-divider</a></p></li>
<li><p><a class="reference internal" href="#feature-state" id="id41">feature-state</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#attribute-sets" id="id42">Attribute sets</a></p>
<ul>
<li><p><a class="reference internal" href="#dpll" id="id43">dpll</a></p></li>
<li><p><a class="reference internal" href="#pin" id="id44">pin</a></p></li>
<li><p><a class="reference internal" href="#pin-parent-device" id="id45">pin-parent-device</a></p></li>
<li><p><a class="reference internal" href="#pin-parent-pin" id="id46">pin-parent-pin</a></p></li>
<li><p><a class="reference internal" href="#frequency-range" id="id47">frequency-range</a></p></li>
<li><p><a class="reference internal" href="#reference-sync" id="id48">reference-sync</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
<section id="summary">
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Summary</a><a class="headerlink" href="#summary" title="Link to this heading">¶</a></h2>
<p>DPLL subsystem.</p>
</section>
<section id="operations">
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Operations</a><a class="headerlink" href="#operations" title="Link to this heading">¶</a></h2>
<section id="device-id-get">
<span id="dpll-operation-device-id-get"></span><h3><a class="toc-backref" href="#id12" role="doc-backlink">device-id-get</a><a class="headerlink" href="#device-id-get" title="Link to this heading">¶</a></h3>
<p>Get id of dpll device that matches given attributes</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-dpll"><span class="std std-ref">dpll</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-lock-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-unlock-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="device-get">
<span id="dpll-operation-device-get"></span><h3><a class="toc-backref" href="#id13" role="doc-backlink">device-get</a><a class="headerlink" href="#device-get" title="Link to this heading">¶</a></h3>
<p>Get list of DPLL devices (dump) or attributes of a single dpll device</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-dpll"><span class="std std-ref">dpll</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">mode</span></code>, <code class="docutils literal notranslate"><span class="pre">mode-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">lock-status</span></code>, <code class="docutils literal notranslate"><span class="pre">lock-status-error</span></code>, <code class="docutils literal notranslate"><span class="pre">temp</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-monitor</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-avg-factor</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt class="field-even">dump<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">mode</span></code>, <code class="docutils literal notranslate"><span class="pre">mode-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">lock-status</span></code>, <code class="docutils literal notranslate"><span class="pre">lock-status-error</span></code>, <code class="docutils literal notranslate"><span class="pre">temp</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-monitor</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-avg-factor</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="device-set">
<span id="dpll-operation-device-set"></span><h3><a class="toc-backref" href="#id14" role="doc-backlink">device-set</a><a class="headerlink" href="#device-set" title="Link to this heading">¶</a></h3>
<p>Set attributes for a DPLL device</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-dpll"><span class="std std-ref">dpll</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-monitor</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-offset-avg-factor</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="device-create-ntf">
<span id="dpll-operation-device-create-ntf"></span><h3><a class="toc-backref" href="#id15" role="doc-backlink">device-create-ntf</a><a class="headerlink" href="#device-create-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about device appearing</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>device-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
<section id="device-delete-ntf">
<span id="dpll-operation-device-delete-ntf"></span><h3><a class="toc-backref" href="#id16" role="doc-backlink">device-delete-ntf</a><a class="headerlink" href="#device-delete-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about device disappearing</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>device-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
<section id="device-change-ntf">
<span id="dpll-operation-device-change-ntf"></span><h3><a class="toc-backref" href="#id17" role="doc-backlink">device-change-ntf</a><a class="headerlink" href="#device-change-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about device configuration being changed</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>device-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
<section id="pin-id-get">
<span id="dpll-operation-pin-id-get"></span><h3><a class="toc-backref" href="#id18" role="doc-backlink">pin-id-get</a><a class="headerlink" href="#pin-id-get" title="Link to this heading">¶</a></h3>
<p>Get id of a pin that matches given attributes</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-pin"><span class="std std-ref">pin</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-lock-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-unlock-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">board-label</span></code>, <code class="docutils literal notranslate"><span class="pre">panel-label</span></code>, <code class="docutils literal notranslate"><span class="pre">package-label</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-get">
<span id="dpll-operation-pin-get"></span><h3><a class="toc-backref" href="#id19" role="doc-backlink">pin-get</a><a class="headerlink" href="#pin-get" title="Link to this heading">¶</a></h3>
<p>Get list of pins and its attributes.</p>
<ul class="simple">
<li><p>dump request without any attributes given - list all the pins in the
system</p></li>
<li><p>dump request with target dpll - list all the pins registered with
a given dpll device</p></li>
<li><p>do request with target dpll and target pin - single pin attributes</p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-pin"><span class="std std-ref">pin</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-pin-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-pin-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">board-label</span></code>, <code class="docutils literal notranslate"><span class="pre">panel-label</span></code>, <code class="docutils literal notranslate"><span class="pre">package-label</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>, <code class="docutils literal notranslate"><span class="pre">frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">frequency-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">capabilities</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-device</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-pin</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-gran</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-min</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-max</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust</span></code>, <code class="docutils literal notranslate"><span class="pre">fractional-frequency-offset</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-frequency-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-pulse</span></code>, <code class="docutils literal notranslate"><span class="pre">reference-sync</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt class="field-even">dump<span class="colon">:</span></dt>
<dd class="field-even"><dl class="simple">
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>]</p>
</dd>
</dl>
</dd>
<dt><strong>reply</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">module-name</span></code>, <code class="docutils literal notranslate"><span class="pre">clock-id</span></code>, <code class="docutils literal notranslate"><span class="pre">board-label</span></code>, <code class="docutils literal notranslate"><span class="pre">panel-label</span></code>, <code class="docutils literal notranslate"><span class="pre">package-label</span></code>, <code class="docutils literal notranslate"><span class="pre">type</span></code>, <code class="docutils literal notranslate"><span class="pre">frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">frequency-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">capabilities</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-device</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-pin</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-gran</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-min</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust-max</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust</span></code>, <code class="docutils literal notranslate"><span class="pre">fractional-frequency-offset</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-frequency-supported</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-pulse</span></code>, <code class="docutils literal notranslate"><span class="pre">reference-sync</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-set">
<span id="dpll-operation-pin-set"></span><h3><a class="toc-backref" href="#id20" role="doc-backlink">pin-set</a><a class="headerlink" href="#pin-set" title="Link to this heading">¶</a></h3>
<p>Set attributes of a target pin</p>
<dl class="field-list simple">
<dt class="field-odd">attribute-set<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-attribute-set-pin"><span class="std std-ref">pin</span></a></p>
</dd>
<dt class="field-even">flags<span class="colon">:</span></dt>
<dd class="field-even"><p>[<code class="docutils literal notranslate"><span class="pre">admin-perm</span></code>]</p>
</dd>
<dt class="field-odd">do<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>pre</strong></dt><dd><p>dpll-pin-pre-doit</p>
</dd>
<dt><strong>post</strong></dt><dd><p>dpll-pin-post-doit</p>
</dd>
<dt><strong>request</strong></dt><dd><dl class="field-list simple">
<dt class="field-odd">attributes<span class="colon">:</span></dt>
<dd class="field-odd"><p>[<code class="docutils literal notranslate"><span class="pre">id</span></code>, <code class="docutils literal notranslate"><span class="pre">frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">direction</span></code>, <code class="docutils literal notranslate"><span class="pre">prio</span></code>, <code class="docutils literal notranslate"><span class="pre">state</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-device</span></code>, <code class="docutils literal notranslate"><span class="pre">parent-pin</span></code>, <code class="docutils literal notranslate"><span class="pre">phase-adjust</span></code>, <code class="docutils literal notranslate"><span class="pre">esync-frequency</span></code>, <code class="docutils literal notranslate"><span class="pre">reference-sync</span></code>]</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-create-ntf">
<span id="dpll-operation-pin-create-ntf"></span><h3><a class="toc-backref" href="#id21" role="doc-backlink">pin-create-ntf</a><a class="headerlink" href="#pin-create-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about pin appearing</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
<section id="pin-delete-ntf">
<span id="dpll-operation-pin-delete-ntf"></span><h3><a class="toc-backref" href="#id22" role="doc-backlink">pin-delete-ntf</a><a class="headerlink" href="#pin-delete-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about pin disappearing</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
<section id="pin-change-ntf">
<span id="dpll-operation-pin-change-ntf"></span><h3><a class="toc-backref" href="#id23" role="doc-backlink">pin-change-ntf</a><a class="headerlink" href="#pin-change-ntf" title="Link to this heading">¶</a></h3>
<p>Notification about pin configuration being changed</p>
<dl class="field-list simple">
<dt class="field-odd">notify<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin-get</p>
</dd>
<dt class="field-even">mcgrp<span class="colon">:</span></dt>
<dd class="field-even"><p>monitor</p>
</dd>
</dl>
</section>
</section>
<section id="multicast-groups">
<h2><a class="toc-backref" href="#id24" role="doc-backlink">Multicast groups</a><a class="headerlink" href="#multicast-groups" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>monitor</p></li>
</ul>
</section>
<section id="definitions">
<h2><a class="toc-backref" href="#id25" role="doc-backlink">Definitions</a><a class="headerlink" href="#definitions" title="Link to this heading">¶</a></h2>
<section id="mode">
<span id="dpll-definition-mode"></span><h3><a class="toc-backref" href="#id26" role="doc-backlink">mode</a><a class="headerlink" href="#mode" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>working modes a dpll can support, differentiates if and how dpll selects one of its inputs to syntonize with it, valid values for DPLL_A_MODE attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">manual<span class="colon">:</span></dt>
<dd class="field-odd"><p>input can be only selected by sending a request to dpll</p>
</dd>
<dt class="field-even">automatic<span class="colon">:</span></dt>
<dd class="field-even"><p>highest prio input pin auto selected by dpll</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="lock-status">
<span id="dpll-definition-lock-status"></span><h3><a class="toc-backref" href="#id27" role="doc-backlink">lock-status</a><a class="headerlink" href="#lock-status" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>provides information of dpll device lock status, valid values for DPLL_A_LOCK_STATUS attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">unlocked<span class="colon">:</span></dt>
<dd class="field-odd"><p>dpll was not yet locked to any valid input (or forced by setting DPLL_A_MODE to DPLL_MODE_DETACHED)</p>
</dd>
<dt class="field-even">locked<span class="colon">:</span></dt>
<dd class="field-even"><p>dpll is locked to a valid signal, but no holdover available</p>
</dd>
<dt class="field-odd">locked-ho-acq<span class="colon">:</span></dt>
<dd class="field-odd"><p>dpll is locked and holdover acquired</p>
</dd>
<dt class="field-even">holdover<span class="colon">:</span></dt>
<dd class="field-even"><p>dpll is in holdover state - lost a valid lock or was forced by disconnecting all the pins (latter possible only when dpll lock-state was already DPLL_LOCK_STATUS_LOCKED_HO_ACQ, if dpll lock-state was not DPLL_LOCK_STATUS_LOCKED_HO_ACQ, the dpll’s lock-state shall remain DPLL_LOCK_STATUS_UNLOCKED)</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="lock-status-error">
<span id="dpll-definition-lock-status-error"></span><h3><a class="toc-backref" href="#id28" role="doc-backlink">lock-status-error</a><a class="headerlink" href="#lock-status-error" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>if previous status change was done due to a failure, this provides information of dpll device lock status error. Valid values for DPLL_A_LOCK_STATUS_ERROR attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">none<span class="colon">:</span></dt>
<dd class="field-odd"><p>dpll device lock status was changed without any error</p>
</dd>
<dt class="field-even">undefined<span class="colon">:</span></dt>
<dd class="field-even"><p>dpll device lock status was changed due to undefined error. Driver fills this value up in case it is not able to obtain suitable exact error type.</p>
</dd>
<dt class="field-odd">media-down<span class="colon">:</span></dt>
<dd class="field-odd"><p>dpll device lock status was changed because of associated media got down. This may happen for example if dpll device was previously locked on an input pin of type PIN_TYPE_SYNCE_ETH_PORT.</p>
</dd>
<dt class="field-even">fractional-frequency-offset-too-high<span class="colon">:</span></dt>
<dd class="field-even"><p>the FFO (Fractional Frequency Offset) between the RX and TX symbol rate on the media got too high. This may happen for example if dpll device was previously locked on an input pin of type PIN_TYPE_SYNCE_ETH_PORT.</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="clock-quality-level">
<span id="dpll-definition-clock-quality-level"></span><h3><a class="toc-backref" href="#id29" role="doc-backlink">clock-quality-level</a><a class="headerlink" href="#clock-quality-level" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>level of quality of a clock device. This mainly applies when the dpll lock-status is DPLL_LOCK_STATUS_HOLDOVER. The current list is defined according to the table 11-7 contained in ITU-T G.8264/Y.1364 document. One may extend this list freely by other ITU-T defined clock qualities, or different ones defined by another standardization body (for those, please use different prefix).</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">itu-opt1-prc<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
<dt class="field-even">itu-opt1-ssu-a<span class="colon">:</span></dt>
<dd class="field-even"><p></p></dd>
<dt class="field-odd">itu-opt1-ssu-b<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
<dt class="field-even">itu-opt1-eec1<span class="colon">:</span></dt>
<dd class="field-even"><p></p></dd>
<dt class="field-odd">itu-opt1-prtc<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
<dt class="field-even">itu-opt1-eprtc<span class="colon">:</span></dt>
<dd class="field-even"><p></p></dd>
<dt class="field-odd">itu-opt1-eeec<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
<dt class="field-even">itu-opt1-eprc<span class="colon">:</span></dt>
<dd class="field-even"><p></p></dd>
</dl>
</dd>
</dl>
</section>
<section id="temp-divider">
<span id="dpll-definition-temp-divider"></span><h3><a class="toc-backref" href="#id30" role="doc-backlink">temp-divider</a><a class="headerlink" href="#temp-divider" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>1000</p>
</dd>
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>temperature divider allowing userspace to calculate the temperature as float with three digit decimal precision. Value of (DPLL_A_TEMP / DPLL_TEMP_DIVIDER) is integer part of temperature value. Value of (DPLL_A_TEMP % DPLL_TEMP_DIVIDER) is fractional part of temperature value.</p>
</dd>
</dl>
</section>
<section id="type">
<span id="dpll-definition-type"></span><h3><a class="toc-backref" href="#id31" role="doc-backlink">type</a><a class="headerlink" href="#type" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>type of dpll, valid values for DPLL_A_TYPE attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">pps<span class="colon">:</span></dt>
<dd class="field-odd"><p>dpll produces Pulse-Per-Second signal</p>
</dd>
<dt class="field-even">eec<span class="colon">:</span></dt>
<dd class="field-even"><p>dpll drives the Ethernet Equipment Clock</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-type">
<span id="dpll-definition-pin-type"></span><h3><a class="toc-backref" href="#id32" role="doc-backlink">pin-type</a><a class="headerlink" href="#pin-type" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>defines possible types of a pin, valid values for DPLL_A_PIN_TYPE attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">mux<span class="colon">:</span></dt>
<dd class="field-odd"><p>aggregates another layer of selectable pins</p>
</dd>
<dt class="field-even">ext<span class="colon">:</span></dt>
<dd class="field-even"><p>external input</p>
</dd>
<dt class="field-odd">synce-eth-port<span class="colon">:</span></dt>
<dd class="field-odd"><p>ethernet port PHY’s recovered clock</p>
</dd>
<dt class="field-even">int-oscillator<span class="colon">:</span></dt>
<dd class="field-even"><p>device internal oscillator</p>
</dd>
<dt class="field-odd">gnss<span class="colon">:</span></dt>
<dd class="field-odd"><p>GNSS recovered clock</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-direction">
<span id="dpll-definition-pin-direction"></span><h3><a class="toc-backref" href="#id33" role="doc-backlink">pin-direction</a><a class="headerlink" href="#pin-direction" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>defines possible direction of a pin, valid values for DPLL_A_PIN_DIRECTION attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">input<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin used as a input of a signal</p>
</dd>
<dt class="field-even">output<span class="colon">:</span></dt>
<dd class="field-even"><p>pin used to output the signal</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-frequency-1-hz">
<span id="dpll-definition-pin-frequency-1-hz"></span><h3><a class="toc-backref" href="#id34" role="doc-backlink">pin-frequency-1-hz</a><a class="headerlink" href="#pin-frequency-1-hz" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>1</p>
</dd>
</dl>
</section>
<section id="pin-frequency-10-khz">
<span id="dpll-definition-pin-frequency-10-khz"></span><h3><a class="toc-backref" href="#id35" role="doc-backlink">pin-frequency-10-khz</a><a class="headerlink" href="#pin-frequency-10-khz" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>10000</p>
</dd>
</dl>
</section>
<section id="pin-frequency-77-5-khz">
<span id="dpll-definition-pin-frequency-77-5-khz"></span><h3><a class="toc-backref" href="#id36" role="doc-backlink">pin-frequency-77-5-khz</a><a class="headerlink" href="#pin-frequency-77-5-khz" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>77500</p>
</dd>
</dl>
</section>
<section id="pin-frequency-10-mhz">
<span id="dpll-definition-pin-frequency-10-mhz"></span><h3><a class="toc-backref" href="#id37" role="doc-backlink">pin-frequency-10-mhz</a><a class="headerlink" href="#pin-frequency-10-mhz" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>10000000</p>
</dd>
</dl>
</section>
<section id="pin-state">
<span id="dpll-definition-pin-state"></span><h3><a class="toc-backref" href="#id38" role="doc-backlink">pin-state</a><a class="headerlink" href="#pin-state" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>defines possible states of a pin, valid values for DPLL_A_PIN_STATE attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">connected<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin connected, active input of phase locked loop</p>
</dd>
<dt class="field-even">disconnected<span class="colon">:</span></dt>
<dd class="field-even"><p>pin disconnected, not considered as a valid input</p>
</dd>
<dt class="field-odd">selectable<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin enabled for automatic input selection</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="pin-capabilities">
<span id="dpll-definition-pin-capabilities"></span><h3><a class="toc-backref" href="#id39" role="doc-backlink">pin-capabilities</a><a class="headerlink" href="#pin-capabilities" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>flags</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>defines possible capabilities of a pin, valid flags on DPLL_A_PIN_CAPABILITIES attribute</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">direction-can-change<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin direction can be changed</p>
</dd>
<dt class="field-even">priority-can-change<span class="colon">:</span></dt>
<dd class="field-even"><p>pin priority can be changed</p>
</dd>
<dt class="field-odd">state-can-change<span class="colon">:</span></dt>
<dd class="field-odd"><p>pin state can be changed</p>
</dd>
</dl>
</dd>
</dl>
</section>
<section id="phase-offset-divider">
<span id="dpll-definition-phase-offset-divider"></span><h3><a class="toc-backref" href="#id40" role="doc-backlink">phase-offset-divider</a><a class="headerlink" href="#phase-offset-divider" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>const</p>
</dd>
<dt class="field-even">value<span class="colon">:</span></dt>
<dd class="field-even"><p>1000</p>
</dd>
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>phase offset divider allows userspace to calculate a value of measured signal phase difference between a pin and dpll device as a fractional value with three digit decimal precision. Value of (DPLL_A_PHASE_OFFSET / DPLL_PHASE_OFFSET_DIVIDER) is an integer part of a measured phase offset value. Value of (DPLL_A_PHASE_OFFSET % DPLL_PHASE_OFFSET_DIVIDER) is a fractional part of a measured phase offset value.</p>
</dd>
</dl>
</section>
<section id="feature-state">
<span id="dpll-definition-feature-state"></span><h3><a class="toc-backref" href="#id41" role="doc-backlink">feature-state</a><a class="headerlink" href="#feature-state" title="Link to this heading">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">type<span class="colon">:</span></dt>
<dd class="field-odd"><p>enum</p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>Allow control (enable/disable) and status checking over features.</p>
</dd>
<dt class="field-odd">entries<span class="colon">:</span></dt>
<dd class="field-odd"><dl class="field-list simple">
<dt class="field-odd">disable<span class="colon">:</span></dt>
<dd class="field-odd"><p>feature shall be disabled</p>
</dd>
<dt class="field-even">enable<span class="colon">:</span></dt>
<dd class="field-even"><p>feature shall be enabled</p>
</dd>
</dl>
</dd>
</dl>
</section>
</section>
<section id="attribute-sets">
<h2><a class="toc-backref" href="#id42" role="doc-backlink">Attribute sets</a><a class="headerlink" href="#attribute-sets" title="Link to this heading">¶</a></h2>
<section id="dpll">
<span id="dpll-attribute-set-dpll"></span><h3><a class="toc-backref" href="#id43" role="doc-backlink">dpll</a><a class="headerlink" href="#dpll" title="Link to this heading">¶</a></h3>
<section id="id-u32">
<h4>id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#id-u32" title="Link to this heading">¶</a></h4>
</section>
<section id="module-name-string">
<h4>module-name (<code class="docutils literal notranslate"><span class="pre">string</span></code>)<a class="headerlink" href="#module-name-string" title="Link to this heading">¶</a></h4>
</section>
<section id="pad-pad">
<h4>pad (<code class="docutils literal notranslate"><span class="pre">pad</span></code>)<a class="headerlink" href="#pad-pad" title="Link to this heading">¶</a></h4>
</section>
<section id="clock-id-u64">
<h4>clock-id (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#clock-id-u64" title="Link to this heading">¶</a></h4>
</section>
<section id="mode-u32">
<h4>mode (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#mode-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-mode"><span class="std std-ref">mode</span></a></p>
</dd>
</dl>
</section>
<section id="mode-supported-u32">
<h4>mode-supported (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#mode-supported-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-mode"><span class="std std-ref">mode</span></a></p>
</dd>
<dt class="field-even">multi-attr<span class="colon">:</span></dt>
<dd class="field-even"><p>True</p>
</dd>
</dl>
</section>
<section id="lock-status-u32">
<h4>lock-status (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#lock-status-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-lock-status"><span class="std std-ref">lock-status</span></a></p>
</dd>
</dl>
</section>
<section id="temp-s32">
<h4>temp (<code class="docutils literal notranslate"><span class="pre">s32</span></code>)<a class="headerlink" href="#temp-s32" title="Link to this heading">¶</a></h4>
</section>
<section id="type-u32">
<h4>type (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#type-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-type"><span class="std std-ref">type</span></a></p>
</dd>
</dl>
</section>
<section id="lock-status-error-u32">
<h4>lock-status-error (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#lock-status-error-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-lock-status-error"><span class="std std-ref">lock-status-error</span></a></p>
</dd>
</dl>
</section>
<section id="clock-quality-level-u32">
<h4>clock-quality-level (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#clock-quality-level-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-clock-quality-level"><span class="std std-ref">clock-quality-level</span></a></p>
</dd>
<dt class="field-even">multi-attr<span class="colon">:</span></dt>
<dd class="field-even"><p>True</p>
</dd>
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Level of quality of a clock device. This mainly applies when the dpll lock-status is DPLL_LOCK_STATUS_HOLDOVER. This could be put to message multiple times to indicate possible parallel quality levels (e.g. one specified by ITU option 1 and another one specified by option 2).</p>
</dd>
</dl>
</section>
<section id="phase-offset-monitor-u32">
<h4>phase-offset-monitor (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#phase-offset-monitor-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-feature-state"><span class="std std-ref">feature-state</span></a></p>
</dd>
<dt class="field-even">doc<span class="colon">:</span></dt>
<dd class="field-even"><p>Receive or request state of phase offset monitor feature. If enabled, dpll device shall monitor and notify all currently available inputs for changes of their phase offset against the dpll device.</p>
</dd>
</dl>
</section>
<section id="phase-offset-avg-factor-u32">
<h4>phase-offset-avg-factor (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#phase-offset-avg-factor-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Averaging factor applied to calculation of reported phase offset.</p>
</dd>
</dl>
</section>
</section>
<section id="pin">
<span id="dpll-attribute-set-pin"></span><h3><a class="toc-backref" href="#id44" role="doc-backlink">pin</a><a class="headerlink" href="#pin" title="Link to this heading">¶</a></h3>
<section id="id1">
<h4>id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h4>
</section>
<section id="parent-id-u32">
<h4>parent-id (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#parent-id-u32" title="Link to this heading">¶</a></h4>
</section>
<section id="id2">
<h4>module-name (<code class="docutils literal notranslate"><span class="pre">string</span></code>)<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h4>
</section>
<section id="id3">
<h4>pad (<code class="docutils literal notranslate"><span class="pre">pad</span></code>)<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>
</section>
<section id="id4">
<h4>clock-id (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h4>
</section>
<section id="board-label-string">
<h4>board-label (<code class="docutils literal notranslate"><span class="pre">string</span></code>)<a class="headerlink" href="#board-label-string" title="Link to this heading">¶</a></h4>
</section>
<section id="panel-label-string">
<h4>panel-label (<code class="docutils literal notranslate"><span class="pre">string</span></code>)<a class="headerlink" href="#panel-label-string" title="Link to this heading">¶</a></h4>
</section>
<section id="package-label-string">
<h4>package-label (<code class="docutils literal notranslate"><span class="pre">string</span></code>)<a class="headerlink" href="#package-label-string" title="Link to this heading">¶</a></h4>
</section>
<section id="id5">
<h4>type (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-pin-type"><span class="std std-ref">pin-type</span></a></p>
</dd>
</dl>
</section>
<section id="direction-u32">
<h4>direction (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#direction-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-pin-direction"><span class="std std-ref">pin-direction</span></a></p>
</dd>
</dl>
</section>
<section id="frequency-u64">
<h4>frequency (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#frequency-u64" title="Link to this heading">¶</a></h4>
</section>
<section id="frequency-supported-nest">
<h4>frequency-supported (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#frequency-supported-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">multi-attr<span class="colon">:</span></dt>
<dd class="field-odd"><p>True</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#dpll-attribute-set-frequency-range"><span class="std std-ref">frequency-range</span></a></p>
</dd>
</dl>
</section>
<section id="frequency-min-u64">
<h4>frequency-min (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#frequency-min-u64" title="Link to this heading">¶</a></h4>
</section>
<section id="frequency-max-u64">
<h4>frequency-max (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#frequency-max-u64" title="Link to this heading">¶</a></h4>
</section>
<section id="prio-u32">
<h4>prio (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#prio-u32" title="Link to this heading">¶</a></h4>
</section>
<section id="state-u32">
<h4>state (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#state-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-pin-state"><span class="std std-ref">pin-state</span></a></p>
</dd>
</dl>
</section>
<section id="capabilities-u32">
<h4>capabilities (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#capabilities-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">enum<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#dpll-definition-pin-capabilities"><span class="std std-ref">pin-capabilities</span></a></p>
</dd>
</dl>
</section>
<section id="parent-device-nest">
<h4>parent-device (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#parent-device-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">multi-attr<span class="colon">:</span></dt>
<dd class="field-odd"><p>True</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#dpll-attribute-set-pin-parent-device"><span class="std std-ref">pin-parent-device</span></a></p>
</dd>
</dl>
</section>
<section id="parent-pin-nest">
<h4>parent-pin (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#parent-pin-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">multi-attr<span class="colon">:</span></dt>
<dd class="field-odd"><p>True</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#dpll-attribute-set-pin-parent-pin"><span class="std std-ref">pin-parent-pin</span></a></p>
</dd>
</dl>
</section>
<section id="phase-adjust-min-s32">
<h4>phase-adjust-min (<code class="docutils literal notranslate"><span class="pre">s32</span></code>)<a class="headerlink" href="#phase-adjust-min-s32" title="Link to this heading">¶</a></h4>
</section>
<section id="phase-adjust-max-s32">
<h4>phase-adjust-max (<code class="docutils literal notranslate"><span class="pre">s32</span></code>)<a class="headerlink" href="#phase-adjust-max-s32" title="Link to this heading">¶</a></h4>
</section>
<section id="phase-adjust-s32">
<h4>phase-adjust (<code class="docutils literal notranslate"><span class="pre">s32</span></code>)<a class="headerlink" href="#phase-adjust-s32" title="Link to this heading">¶</a></h4>
</section>
<section id="phase-offset-s64">
<h4>phase-offset (<code class="docutils literal notranslate"><span class="pre">s64</span></code>)<a class="headerlink" href="#phase-offset-s64" title="Link to this heading">¶</a></h4>
</section>
<section id="fractional-frequency-offset-sint">
<h4>fractional-frequency-offset (<code class="docutils literal notranslate"><span class="pre">sint</span></code>)<a class="headerlink" href="#fractional-frequency-offset-sint" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>The FFO (Fractional Frequency Offset) between the RX and TX symbol rate on the media associated with the pin: (rx_frequency-tx_frequency)/rx_frequency Value is in PPM (parts per million). This may be implemented for example for pin of type PIN_TYPE_SYNCE_ETH_PORT.</p>
</dd>
</dl>
</section>
<section id="esync-frequency-u64">
<h4>esync-frequency (<code class="docutils literal notranslate"><span class="pre">u64</span></code>)<a class="headerlink" href="#esync-frequency-u64" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Frequency of Embedded SYNC signal. If provided, the pin is configured with a SYNC signal embedded into its base clock frequency.</p>
</dd>
</dl>
</section>
<section id="esync-frequency-supported-nest">
<h4>esync-frequency-supported (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#esync-frequency-supported-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">multi-attr<span class="colon">:</span></dt>
<dd class="field-odd"><p>True</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#dpll-attribute-set-frequency-range"><span class="std std-ref">frequency-range</span></a></p>
</dd>
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>If provided a pin is capable of embedding a SYNC signal (within given range) into its base frequency signal.</p>
</dd>
</dl>
</section>
<section id="esync-pulse-u32">
<h4>esync-pulse (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#esync-pulse-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>A ratio of high to low state of a SYNC signal pulse embedded into base clock frequency. Value is in percents.</p>
</dd>
</dl>
</section>
<section id="reference-sync-nest">
<h4>reference-sync (<code class="docutils literal notranslate"><span class="pre">nest</span></code>)<a class="headerlink" href="#reference-sync-nest" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">multi-attr<span class="colon">:</span></dt>
<dd class="field-odd"><p>True</p>
</dd>
<dt class="field-even">nested-attributes<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#dpll-attribute-set-reference-sync"><span class="std std-ref">reference-sync</span></a></p>
</dd>
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Capable pin provides list of pins that can be bound to create a reference-sync pin pair.</p>
</dd>
</dl>
</section>
<section id="phase-adjust-gran-u32">
<h4>phase-adjust-gran (<code class="docutils literal notranslate"><span class="pre">u32</span></code>)<a class="headerlink" href="#phase-adjust-gran-u32" title="Link to this heading">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">doc<span class="colon">:</span></dt>
<dd class="field-odd"><p>Granularity of phase adjustment, in picoseconds. The value of phase adjustment must be a multiple of this granularity.</p>
</dd>
</dl>
</section>
</section>
<section id="pin-parent-device">
<span id="dpll-attribute-set-pin-parent-device"></span><h3><a class="toc-backref" href="#id45" role="doc-backlink">pin-parent-device</a><a class="headerlink" href="#pin-parent-device" title="Link to this heading">¶</a></h3>
<section id="parent-id">
<h4>parent-id<a class="headerlink" href="#parent-id" title="Link to this heading">¶</a></h4>
</section>
<section id="direction">
<h4>direction<a class="headerlink" href="#direction" title="Link to this heading">¶</a></h4>
</section>
<section id="prio">
<h4>prio<a class="headerlink" href="#prio" title="Link to this heading">¶</a></h4>
</section>
<section id="state">
<h4>state<a class="headerlink" href="#state" title="Link to this heading">¶</a></h4>
</section>
<section id="phase-offset">
<h4>phase-offset<a class="headerlink" href="#phase-offset" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="pin-parent-pin">
<span id="dpll-attribute-set-pin-parent-pin"></span><h3><a class="toc-backref" href="#id46" role="doc-backlink">pin-parent-pin</a><a class="headerlink" href="#pin-parent-pin" title="Link to this heading">¶</a></h3>
<section id="id6">
<h4>parent-id<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h4>
</section>
<section id="id7">
<h4>state<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="frequency-range">
<span id="dpll-attribute-set-frequency-range"></span><h3><a class="toc-backref" href="#id47" role="doc-backlink">frequency-range</a><a class="headerlink" href="#frequency-range" title="Link to this heading">¶</a></h3>
<section id="frequency-min">
<h4>frequency-min<a class="headerlink" href="#frequency-min" title="Link to this heading">¶</a></h4>
</section>
<section id="frequency-max">
<h4>frequency-max<a class="headerlink" href="#frequency-max" title="Link to this heading">¶</a></h4>
</section>
</section>
<section id="reference-sync">
<span id="dpll-attribute-set-reference-sync"></span><h3><a class="toc-backref" href="#id48" role="doc-backlink">reference-sync</a><a class="headerlink" href="#reference-sync" title="Link to this heading">¶</a></h3>
<section id="id">
<h4>id<a class="headerlink" href="#id" title="Link to this heading">¶</a></h4>
</section>
<section id="id8">
<h4>state<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h4>
</section>
</section>
</section>
</section>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©The kernel development community.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a>
& <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
|
<a href="../../_sources/netlink/specs/dpll.yaml.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>