From: Vaishnav Achath <vaishnav.a@ti.com>
To: Ayush Singh <ayushdevel1325@gmail.com>,
open list <linux-kernel@vger.kernel.org>
Cc: <jkridner@beagleboard.org>, <robertcnelson@beagleboard.org>,
<lorforlinux@beagleboard.org>, Rob Herring <robh@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>, Nishanth Menon <nm@ti.com>,
Vignesh Raghavendra <vigneshr@ti.com>,
Tero Kristo <kristo@kernel.org>,
Derek Kiernan <derek.kiernan@amd.com>,
Dragan Cvetic <dragan.cvetic@amd.com>,
Arnd Bergmann <arnd@arndb.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Mark Brown <broonie@kernel.org>, Johan Hovold <johan@kernel.org>,
Alex Elder <elder@kernel.org>,
"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS"
<devicetree@vger.kernel.org>,
"moderated list:ARM/TEXAS INSTRUMENTS K3 ARCHITECTURE"
<linux-arm-kernel@lists.infradead.org>,
"open list:SPI SUBSYSTEM" <linux-spi@vger.kernel.org>,
"moderated list:GREYBUS SUBSYSTEM" <greybus-dev@lists.linaro.org>,
Vaishnav M A <vaishnav@beagleboard.org>
Subject: Re: [PATCH v4 3/5] greybus: Add mikroBUS manifest types
Date: Tue, 19 Mar 2024 13:56:29 +0530 [thread overview]
Message-ID: <6eff590b-3f4a-4824-95e7-b2a94656408b@ti.com> (raw)
In-Reply-To: <20240317193714.403132-4-ayushdevel1325@gmail.com>
On 18/03/24 01:07, Ayush Singh wrote:
> DONOTMERGE
>
Why?
> mikroBUS addon boards allow using same mikroBUS connector for a wide
> range of peripherals. It is also possible for the addon board not to use
> all the pins in mikroBUS socket (marked by NC or Not Connected). This
> would require the need to create an almost new overlays for each
> permutation of the hardware.
>
> To overcome this, a manifest format based on Greybus manifest
> specification was created which allows describing mikroBUS addon boards.
> The reason for choosing greybus manifest for the identifier is that so far
> we discussed only about physical mikroBUS ports on the board, but we can
you will need to reword the commit message properly in imperative mood,
here and in multiple other places.
> also have mikroBUS ports on a remote microcontroller appearing on host
> over greybus and there a device tree overlay solution does not work as the
> standard identifier mechanism.
>
> The patch introduces 3 new greybus descriptor types:
> 1. mikrobus-descriptor:
> Is a fixed-length descriptor (12 bytes), and the manifest shall have
> precisely one mikroBUS descriptor. Each byte describes a configuration
> of the corresponding pin on the mikroBUS addon board in a clockwise
> direction starting from the PWM pin omitting power (VCC and ground)
> pins as same as the default state of the pin.
> There are mikroBUS addon boards that use some dedicated SPI, UART, PWM,
> and I2C pins as GPIO pins, so it is necessary to redefine the default
> pin configuration of that pins on the host system. Also, sometimes it is
> required the pull-up on the host pin for correct functionality
> 2. property-descriptor:
> Are used to pass named properties or named GPIOs to the host. The host
> system uses this information to properly configure specific board
> drivers by passing the properties and GPIO name. There can be multiple
> instances of property descriptors per add-on board manifest.
> 3. device-descriptor:
> Describes a device on the mikroBUS port. The device descriptor is a
> fixed-length descriptor, and there can be multiple instances of device
> descriptors in an add-on board manifest in cases where the add-on board
> presents more than one device to the host.
>
> New mikroBUS addon boards also sometimes contain a 1-wire EEPROM with
> the mikroBUS manifest, thus enabling plug and play support.
>
new mikroBUS sometimes contain an EEPROM? aren't these called Click ID
compliant add-on boards? there should be clarity in the commit message.
> I have also created PR to add mikrobus descriptors in Greybus spec and I
> think the old PR on manifesto by Vaishnav should also work. However,
> both of these repositories seem to be inactive. I am guessing the
> greybus mailing list can provide more information on how I should go
> about these.
Why is information like these inside the commit message, these go below
the tear line.
>
> Here is a sample mikroBUS manifest:
> ```
> ;;
> ; PRESSURE CLICK
> ; https://www.mikroe.com/pressure-click
> ; CONFIG_IIO_ST_PRESS
> ;
> ; Copyright 2020 BeagleBoard.org Foundation
> ; Copyright 2020 Texas Instruments
> ;
>
> [manifest-header]
> version-major = 0
> version-minor = 1
>
> [interface-descriptor]
> vendor-string-id = 1
> product-string-id = 2
>
> [string-descriptor 1]
> string = MIKROE
>
> [string-descriptor 2]
> string = Pressure
>
> [mikrobus-descriptor]
> pwm-state = 4
> int-state = 1
> rx-state = 7
> tx-state = 7
> scl-state = 6
> sda-state = 6
> mosi-state = 5
> miso-state = 5
> sck-state = 5
> cs-state = 5
> rst-state = 2
> an-state = 1
>
> [device-descriptor 1]
> driver-string-id = 3
> protocol = 0x3
> reg = 0x5d
>
> [string-descriptor 3]
> string = lps331ap
> ```
>
> Link: https://www.mikroe.com/clickid ClickID
> Link:
> https://docs.beagleboard.org/latest/projects/beagleconnect/index.html
> beagleconnect
> Link: https://github.com/projectara/greybus-spec Greybus Spec
> Link: https://github.com/projectara/greybus-spec/pull/4 Greybus Spec PR
> Link: https://github.com/projectara/manifesto/pull/2 manifesto PR
>
The manifesto PR might not be updated.
Thanks and Regards,
Vaishnav
> Co-developed-by: Vaishnav M A <vaishnav@beagleboard.org>
> Signed-off-by: Vaishnav M A <vaishnav@beagleboard.org>
> Signed-off-by: Ayush Singh <ayushdevel1325@gmail.com>
> ---
> include/linux/greybus/greybus_manifest.h | 49 ++++++++++++++++++++++++
> 1 file changed, 49 insertions(+)
>
> diff --git a/include/linux/greybus/greybus_manifest.h b/include/linux/greybus/greybus_manifest.h
> index bef9eb2093e9..83241e19d9b3 100644
> --- a/include/linux/greybus/greybus_manifest.h
> +++ b/include/linux/greybus/greybus_manifest.h
> @@ -23,6 +23,9 @@ enum greybus_descriptor_type {
> GREYBUS_TYPE_STRING = 0x02,
> GREYBUS_TYPE_BUNDLE = 0x03,
> GREYBUS_TYPE_CPORT = 0x04,
> + GREYBUS_TYPE_MIKROBUS = 0x05,
> + GREYBUS_TYPE_PROPERTY = 0x06,
> + GREYBUS_TYPE_DEVICE = 0x07,
> };
>
> enum greybus_protocol {
> @@ -151,6 +154,49 @@ struct greybus_descriptor_cport {
> __u8 protocol_id; /* enum greybus_protocol */
> } __packed;
>
> +/*
> + * A mikrobus descriptor is used to describe the details
> + * about the bus ocnfiguration for the add-on board
> + * connected to the mikrobus port.
> + */
> +struct greybus_descriptor_mikrobus {
> + __u8 pin_state[12];
> +} __packed;
> +
> +/*
> + * A property descriptor is used to pass named properties
> + * to device drivers through the unified device properties
> + * interface under linux/property.h
> + */
> +struct greybus_descriptor_property {
> + __u8 length;
> + __u8 id;
> + __u8 propname_stringid;
> + __u8 type;
> + __u8 value[];
> +} __packed;
> +
> +/*
> + * A device descriptor is used to describe the
> + * details required by a add-on board device
> + * driver.
> + */
> +struct greybus_descriptor_device {
> + __u8 id;
> + __u8 driver_stringid;
> + __u8 protocol;
> + __u8 reg;
> + __le32 max_speed_hz;
> + __u8 irq;
> + __u8 irq_type;
> + __u8 mode;
> + __u8 prop_link;
> + __u8 gpio_link;
> + __u8 reg_link;
> + __u8 clock_link;
> + __u8 pad[1];
> +} __packed;
> +
> struct greybus_descriptor_header {
> __le16 size;
> __u8 type; /* enum greybus_descriptor_type */
> @@ -164,6 +210,9 @@ struct greybus_descriptor {
> struct greybus_descriptor_interface interface;
> struct greybus_descriptor_bundle bundle;
> struct greybus_descriptor_cport cport;
> + struct greybus_descriptor_mikrobus mikrobus;
> + struct greybus_descriptor_property property;
> + struct greybus_descriptor_device device;
> };
> } __packed;
>
next prev parent reply other threads:[~2024-03-19 8:27 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-17 19:37 [PATCH v4 0/5] misc: Add mikroBUS driver Ayush Singh
2024-03-17 19:37 ` [PATCH v4 1/5] dt-bindings: misc: Add mikrobus-connector Ayush Singh
2024-03-18 12:22 ` Michael Walle
2024-03-18 17:20 ` Ayush Singh
2024-03-19 5:58 ` Krzysztof Kozlowski
2024-03-19 7:36 ` Ayush Singh
2024-03-19 9:38 ` Michael Walle
2024-03-19 11:36 ` Ayush Singh
2024-03-19 12:08 ` Michael Walle
2024-03-19 13:03 ` Ayush Singh
2024-03-19 14:21 ` Michael Walle
2024-03-19 17:19 ` Vaishnav Achath
2024-03-19 17:35 ` Ayush Singh
2024-03-19 19:32 ` Andrew Lunn
2024-03-20 16:39 ` Ayush Singh
2024-03-20 18:44 ` Andrew Lunn
2024-03-21 7:35 ` Vaishnav Achath
2024-03-21 12:31 ` Andrew Lunn
2024-03-19 12:25 ` Andrew Lunn
2024-03-19 17:35 ` Vaishnav Achath
2024-03-19 18:19 ` Conor Dooley
2024-03-21 6:30 ` Vaishnav Achath
2024-03-19 19:23 ` Andrew Lunn
2024-03-21 7:07 ` Vaishnav Achath
2024-03-21 9:38 ` Michael Walle
2024-03-21 11:55 ` Vaishnav Achath
2024-03-21 12:44 ` Michael Walle
2024-03-21 12:55 ` Andrew Lunn
2024-03-19 6:03 ` Krzysztof Kozlowski
2024-03-19 6:42 ` Ayush Singh
2024-03-19 19:37 ` Conor Dooley
2024-03-22 18:15 ` Ayush Singh
2024-03-22 18:51 ` Andrew Lunn
2024-03-17 19:37 ` [PATCH v4 2/5] spi: Make of_find_spi_controller_by_node() available Ayush Singh
2024-03-19 8:16 ` Markus Elfring
2024-03-17 19:37 ` [PATCH v4 3/5] greybus: Add mikroBUS manifest types Ayush Singh
2024-03-19 8:26 ` Vaishnav Achath [this message]
2024-03-17 19:37 ` [PATCH v4 4/5] mikrobus: Add mikroBUS driver Ayush Singh
2024-03-17 19:59 ` Randy Dunlap
2024-03-18 17:34 ` Markus Elfring
2024-03-18 17:58 ` Markus Elfring
2024-03-18 18:41 ` Alex Elder
2024-03-18 18:55 ` Greg Kroah-Hartman
2024-03-18 18:12 ` Markus Elfring
2024-03-19 6:04 ` Krzysztof Kozlowski
2024-03-19 6:47 ` Ayush Singh
2024-03-19 8:00 ` Vaishnav Achath
2024-03-20 7:33 ` Krzysztof Kozlowski
2024-03-19 8:49 ` Vaishnav Achath
2024-03-17 19:37 ` [PATCH v4 5/5] dts: ti: k3-am625-beagleplay: Add mikroBUS Ayush Singh
2024-03-19 5:59 ` Krzysztof Kozlowski
2024-03-19 6:34 ` Ayush Singh
2024-03-20 7:31 ` Krzysztof Kozlowski
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=6eff590b-3f4a-4824-95e7-b2a94656408b@ti.com \
--to=vaishnav.a@ti.com \
--cc=arnd@arndb.de \
--cc=ayushdevel1325@gmail.com \
--cc=broonie@kernel.org \
--cc=conor+dt@kernel.org \
--cc=derek.kiernan@amd.com \
--cc=devicetree@vger.kernel.org \
--cc=dragan.cvetic@amd.com \
--cc=elder@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=greybus-dev@lists.linaro.org \
--cc=jkridner@beagleboard.org \
--cc=johan@kernel.org \
--cc=kristo@kernel.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-spi@vger.kernel.org \
--cc=lorforlinux@beagleboard.org \
--cc=nm@ti.com \
--cc=robertcnelson@beagleboard.org \
--cc=robh@kernel.org \
--cc=vaishnav@beagleboard.org \
--cc=vigneshr@ti.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).