From: <Parthiban.Veerasooran@microchip.com>
To: <horms@kernel.org>
Cc: <davem@davemloft.net>, <edumazet@google.com>, <kuba@kernel.org>,
<pabeni@redhat.com>, <saeedm@nvidia.com>,
<anthony.l.nguyen@intel.com>, <netdev@vger.kernel.org>,
<linux-kernel@vger.kernel.org>, <andrew@lunn.ch>,
<corbet@lwn.net>, <linux-doc@vger.kernel.org>,
<robh+dt@kernel.org>, <krzysztof.kozlowski+dt@linaro.org>,
<conor+dt@kernel.org>, <devicetree@vger.kernel.org>,
<Horatiu.Vultur@microchip.com>, <ruanjinjie@huawei.com>,
<Steen.Hegelund@microchip.com>, <vladimir.oltean@nxp.com>,
<UNGLinuxDriver@microchip.com>,
<Thorsten.Kummermehr@microchip.com>, <Pier.Beruto@onsemi.com>,
<Selvamani.Rajagopal@onsemi.com>, <Nicolas.Ferre@microchip.com>,
<benjamin.bigler@bernformulastudent.ch>
Subject: Re: [PATCH net-next v4 01/12] Documentation: networking: add OPEN Alliance 10BASE-T1x MAC-PHY serial interface
Date: Tue, 30 Apr 2024 11:30:10 +0000 [thread overview]
Message-ID: <8164fe59-dde6-41b3-8e9d-8e050d1c7109@microchip.com> (raw)
In-Reply-To: <20240429161716.GZ516117@kernel.org>
Hi Simon,
On 29/04/24 9:47 pm, Simon Horman wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
>
> On Thu, Apr 18, 2024 at 06:26:37PM +0530, Parthiban Veerasooran wrote:
>> The IEEE 802.3cg project defines two 10 Mbit/s PHYs operating over a
>> single pair of conductors. The 10BASE-T1L (Clause 146) is a long reach
>> PHY supporting full duplex point-to-point operation over 1 km of single
>> balanced pair of conductors. The 10BASE-T1S (Clause 147) is a short reach
>> PHY supporting full / half duplex point-to-point operation over 15 m of
>> single balanced pair of conductors, or half duplex multidrop bus
>> operation over 25 m of single balanced pair of conductors.
>>
>> Furthermore, the IEEE 802.3cg project defines the new Physical Layer
>> Collision Avoidance (PLCA) Reconciliation Sublayer (Clause 148) meant to
>> provide improved determinism to the CSMA/CD media access method. PLCA
>> works in conjunction with the 10BASE-T1S PHY operating in multidrop mode.
>>
>> The aforementioned PHYs are intended to cover the low-speed / low-cost
>> applications in industrial and automotive environment. The large number
>> of pins (16) required by the MII interface, which is specified by the
>> IEEE 802.3 in Clause 22, is one of the major cost factors that need to be
>> addressed to fulfil this objective.
>>
>> The MAC-PHY solution integrates an IEEE Clause 4 MAC and a 10BASE-T1x PHY
>> exposing a low pin count Serial Peripheral Interface (SPI) to the host
>> microcontroller. This also enables the addition of Ethernet functionality
>> to existing low-end microcontrollers which do not integrate a MAC
>> controller.
>>
>> Signed-off-by: Parthiban Veerasooran <Parthiban.Veerasooran@microchip.com>
>
> Hi Parthiban,
>
> Some minor feedback from my side.
>
>> ---
>> Documentation/networking/oa-tc6-framework.rst | 491 ++++++++++++++++++
>
> Please add oa-tc6-framework to
>
> Flagged by: make SPHINXDIRS="networking" htmldocs
OK. Thanks for pointing this. Will correct it in the next version.
>
>> MAINTAINERS | 6 +
>> 2 files changed, 497 insertions(+)
>> create mode 100644 Documentation/networking/oa-tc6-framework.rst
>>
>> diff --git a/Documentation/networking/oa-tc6-framework.rst b/Documentation/networking/oa-tc6-framework.rst
>
> ...
>
>> +Device drivers API
>> +==================
>> +
>> +The include/linux/oa_tc6.h defines the following functions:
>> +
>> +.. c:function:: struct oa_tc6 *oa_tc6_init(struct spi_device *spi,
>> + struct net_device *netdev)
>
> I think that you need to use a '\' to escape newlines
> for a for a multi-line c:function.
>
> e.g.
> .. c:function:: struct oa_tc6 *oa_tc6_init(struct spi_device *spi, \
> struct net_device *netdev)
>
> Link: https://www.sphinx-doc.org/en/master/usage/domains/index.html
>
> Flagged by make SPHINXDIRS="networking" htmldocs
> when using Sphinx 7.2.6
Yes noted. Will correct it in the next version.
Best regards,
Parthiban V
>
>> +
>> +Initialize OA TC6 lib.
>> +
>> +.. c:function:: void oa_tc6_exit(struct oa_tc6 *tc6)
>> +
>> +Free allocated OA TC6 lib.
>> +
>> +.. c:function:: int oa_tc6_write_register(struct oa_tc6 *tc6, u32 address,
>> + u32 value)
>> +
>> +Write a single register in the MAC-PHY.
>> +
>> +.. c:function:: int oa_tc6_write_registers(struct oa_tc6 *tc6, u32 address,
>> + u32 value[], u8 length)
>> +
>> +Writing multiple consecutive registers starting from @address in the MAC-PHY.
>> +Maximum of 128 consecutive registers can be written starting at @address.
>> +
>> +.. c:function:: int oa_tc6_read_register(struct oa_tc6 *tc6, u32 address,
>> + u32 *value)
>> +
>> +Read a single register in the MAC-PHY.
>> +
>> +.. c:function:: int oa_tc6_read_registers(struct oa_tc6 *tc6, u32 address,
>> + u32 value[], u8 length)
>> +
>> +Reading multiple consecutive registers starting from @address in the MAC-PHY.
>> +Maximum of 128 consecutive registers can be read starting at @address.
>> +
>> +.. c:function:: netdev_tx_t oa_tc6_start_xmit(struct oa_tc6 *tc6,
>> + struct sk_buff *skb);
>> +
>> +The transmit Ethernet frame in the skb is or going to be transmitted through
>> +the MAC-PHY.
>
> ...
next prev parent reply other threads:[~2024-04-30 11:30 UTC|newest]
Thread overview: 124+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 12:56 [PATCH net-next v4 00/12] Add support for OPEN Alliance 10BASE-T1x MACPHY Serial Interface Parthiban Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 01/12] Documentation: networking: add OPEN Alliance 10BASE-T1x MAC-PHY serial interface Parthiban Veerasooran
2024-04-28 9:33 ` Bagas Sanjaya
2024-04-29 11:31 ` Parthiban.Veerasooran
2024-04-29 16:17 ` Simon Horman
2024-04-30 11:30 ` Parthiban.Veerasooran [this message]
2024-04-18 12:56 ` [PATCH net-next v4 02/12] net: ethernet: oa_tc6: implement register write operation Parthiban Veerasooran
2024-04-22 23:48 ` Andrew Lunn
2024-04-23 4:38 ` Parthiban.Veerasooran
2024-04-23 23:14 ` Andrew Lunn
2024-04-26 5:55 ` Parthiban.Veerasooran
2024-04-29 16:36 ` Simon Horman
2024-04-30 8:14 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 03/12] net: ethernet: oa_tc6: implement register read operation Parthiban Veerasooran
2024-04-23 23:17 ` Andrew Lunn
2024-04-26 5:56 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 04/12] net: ethernet: oa_tc6: implement software reset Parthiban Veerasooran
2024-04-23 23:26 ` Andrew Lunn
2024-04-26 6:38 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 05/12] net: ethernet: oa_tc6: implement error interrupts unmasking Parthiban Veerasooran
2024-04-23 23:27 ` Andrew Lunn
2024-04-27 19:52 ` Ramón Nordin Rodriguez
2024-04-27 21:17 ` Andrew Lunn
2024-04-27 21:55 ` Ramón Nordin Rodriguez
2024-04-28 14:48 ` Andrew Lunn
2024-04-28 9:54 ` Ramón Nordin Rodriguez
2024-04-28 14:59 ` Andrew Lunn
2024-04-28 22:04 ` Ramón Nordin Rodriguez
2024-05-01 18:29 ` Ramón Nordin Rodriguez
2024-05-01 19:58 ` Andrew Lunn
2024-05-01 20:07 ` Andrew Lunn
2024-05-02 10:10 ` Parthiban.Veerasooran
2024-05-02 10:19 ` Ramón Nordin Rodriguez
2024-05-03 7:10 ` Parthiban.Veerasooran
2024-05-06 1:21 ` Andrew Lunn
2024-05-06 6:47 ` Piergiorgio Beruto
2024-05-07 12:44 ` Ramón Nordin Rodriguez
2024-05-13 6:41 ` Ramón Nordin Rodriguez
2024-05-13 13:00 ` Andrew Lunn
2024-05-13 13:50 ` Ramón Nordin Rodriguez
2024-05-13 14:04 ` Andrew Lunn
2024-05-15 21:45 ` Ramón Nordin Rodriguez
2024-05-14 4:46 ` Parthiban.Veerasooran
2024-05-15 21:48 ` Ramón Nordin Rodriguez
2024-05-17 9:38 ` Parthiban.Veerasooran
2024-05-17 12:43 ` Ramón Nordin Rodriguez
2024-05-24 18:12 ` Ramón Nordin Rodriguez
2024-05-24 18:31 ` Andrew Lunn
2024-05-24 18:49 ` Piergiorgio Beruto
2024-05-27 9:30 ` Parthiban.Veerasooran
2024-05-27 8:38 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 06/12] net: ethernet: oa_tc6: implement internal PHY initialization Parthiban Veerasooran
2024-04-23 23:48 ` Andrew Lunn
2024-04-26 13:17 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 07/12] net: ethernet: oa_tc6: enable open alliance tc6 data communication Parthiban Veerasooran
2024-04-23 23:49 ` Andrew Lunn
2024-04-18 12:56 ` [PATCH net-next v4 08/12] net: ethernet: oa_tc6: implement transmit path to transfer tx ethernet frames Parthiban Veerasooran
2024-04-24 0:02 ` Andrew Lunn
2024-04-26 13:19 ` Parthiban.Veerasooran
2024-04-18 12:56 ` [PATCH net-next v4 09/12] net: ethernet: oa_tc6: implement receive path to receive rx " Parthiban Veerasooran
2024-04-24 0:08 ` Andrew Lunn
2024-04-26 13:45 ` Parthiban.Veerasooran
2024-04-26 18:13 ` Andrew Lunn
2024-04-29 6:13 ` Parthiban.Veerasooran
2024-04-27 20:02 ` Ramón Nordin Rodriguez
2024-04-29 8:32 ` Parthiban.Veerasooran
2024-04-29 10:45 ` Ramón Nordin Rodriguez
2024-04-18 12:56 ` [PATCH net-next v4 10/12] net: ethernet: oa_tc6: implement mac-phy interrupt Parthiban Veerasooran
2024-04-24 0:10 ` Andrew Lunn
2024-04-18 12:56 ` [PATCH net-next v4 11/12] microchip: lan865x: add driver support for Microchip's LAN865X MAC-PHY Parthiban Veerasooran
2024-04-24 0:27 ` Andrew Lunn
2024-04-26 13:32 ` Parthiban.Veerasooran
2024-04-26 18:14 ` Andrew Lunn
2024-04-29 6:13 ` Parthiban.Veerasooran
2024-04-27 19:19 ` Ramón Nordin Rodriguez
2024-04-27 19:57 ` Conor Dooley
2024-04-27 20:13 ` Ramón Nordin Rodriguez
2024-04-27 20:22 ` Conor Dooley
2024-04-27 21:09 ` Ramón Nordin Rodriguez
2024-04-29 9:47 ` Parthiban.Veerasooran
2024-04-29 12:09 ` Andrew Lunn
2024-04-30 13:30 ` Parthiban.Veerasooran
2024-04-30 16:55 ` Conor Dooley
2024-05-02 5:56 ` Parthiban.Veerasooran
2024-04-27 20:40 ` Andrew Lunn
2024-04-27 21:06 ` Ramón Nordin Rodriguez
2024-04-28 14:18 ` Andrew Lunn
2024-04-27 19:35 ` Ramón Nordin Rodriguez
2024-04-27 20:58 ` Andrew Lunn
2024-04-27 21:29 ` Ramón Nordin Rodriguez
2024-04-28 14:25 ` Andrew Lunn
2024-04-28 22:00 ` Ramón Nordin Rodriguez
2024-04-18 12:56 ` [PATCH net-next v4 12/12] dt-bindings: net: add Microchip's LAN865X 10BASE-T1S MACPHY Parthiban Veerasooran
2024-04-18 15:39 ` Conor Dooley
2024-04-22 3:59 ` Parthiban.Veerasooran
2024-04-22 15:50 ` Conor Dooley
2024-04-23 3:27 ` Parthiban.Veerasooran
2024-04-22 20:07 ` [PATCH net-next v4 00/12] Add support for OPEN Alliance 10BASE-T1x MACPHY Serial Interface Andrew Lunn
2024-04-22 20:08 ` Andrew Lunn
2024-04-22 23:23 ` Andrew Lunn
2024-05-08 13:05 ` Parthiban.Veerasooran
2024-05-08 17:04 ` Andrew Lunn
2024-05-09 13:04 ` Parthiban.Veerasooran
2024-05-09 20:39 ` Andrew Lunn
2024-05-10 11:22 ` Parthiban.Veerasooran
2024-05-24 20:52 ` Selvamani Rajagopal
2024-05-24 21:27 ` Andrew Lunn
2024-05-24 21:45 ` Piergiorgio Beruto
2024-05-24 21:54 ` Andrew Lunn
2024-05-24 22:08 ` Piergiorgio Beruto
2024-05-25 14:46 ` Andrew Lunn
2024-04-22 23:43 ` Andrew Lunn
2024-04-28 21:16 ` [PATCH net-next v4 13/12] net: lan865x: optional hardware reset Ramón Nordin Rodriguez
2024-04-28 23:17 ` Andrew Lunn
2024-04-29 10:42 ` Ramón Nordin Rodriguez
2024-04-29 6:09 ` Parthiban.Veerasooran
2024-04-29 10:38 ` Ramón Nordin Rodriguez
2024-04-29 12:19 ` Andrew Lunn
2024-04-30 8:04 ` Ramón Nordin Rodriguez
2024-04-30 13:30 ` Parthiban.Veerasooran
2024-04-30 14:14 ` Andrew Lunn
2024-05-02 10:10 ` Parthiban.Veerasooran
2024-04-29 6:09 ` Krzysztof Kozlowski
2024-04-29 10:44 ` Ramón Nordin Rodriguez
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8164fe59-dde6-41b3-8e9d-8e050d1c7109@microchip.com \
--to=parthiban.veerasooran@microchip.com \
--cc=Horatiu.Vultur@microchip.com \
--cc=Nicolas.Ferre@microchip.com \
--cc=Pier.Beruto@onsemi.com \
--cc=Selvamani.Rajagopal@onsemi.com \
--cc=Steen.Hegelund@microchip.com \
--cc=Thorsten.Kummermehr@microchip.com \
--cc=UNGLinuxDriver@microchip.com \
--cc=andrew@lunn.ch \
--cc=anthony.l.nguyen@intel.com \
--cc=benjamin.bigler@bernformulastudent.ch \
--cc=conor+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=robh+dt@kernel.org \
--cc=ruanjinjie@huawei.com \
--cc=saeedm@nvidia.com \
--cc=vladimir.oltean@nxp.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.