Thread (21 messages) 21 messages, 5 authors, 2017-12-05

Re: [PATCH v8 01/13] Documentation: Add SLIMbus summary

From: Srinivas Kandagatla <hidden>
Date: 2017-12-05 22:01:59
Also in: alsa-devel, linux-arm-msm, lkml

Thanks for the review comments.

On 01/12/17 10:27, Jonathan Neuschäfer wrote:
Hi, some small nits below.

On Thu, Nov 30, 2017 at 05:41:48PM +0000, srinivas.kandagatla-QSEj5FYQhm4dnm+yROfE0A@public.gmane.org wrote:
quoted
From: Sagar Dharia <redacted>

SLIMbus (Serial Low Power Interchip Media Bus) is a specification
developed by MIPI (Mobile Industry Processor Interface) alliance.
SLIMbus is a 2-wire implementation, which is used to communicate with
peripheral components like audio-codec.

The summary of SLIMbus and API is documented in the 'summary' file.

Signed-off-by: Sagar Dharia <redacted>
Signed-off-by: Srinivas Kandagatla <redacted>
---
  Documentation/driver-api/slimbus/index.rst   |  15 ++++
  Documentation/driver-api/slimbus/summary.rst | 108 +++++++++++++++++++++++++++
  2 files changed, 123 insertions(+)
  create mode 100644 Documentation/driver-api/slimbus/index.rst
  create mode 100644 Documentation/driver-api/slimbus/summary.rst
It would probably make sense to Cc the documentation maintainers/mailing
list on this patch (AFAICS, you didn't do that).
Yep, I will include them while sending next version.
When do you plan to add slimbus to Documentation/driver-api/index.rst?
that's good point, I will fix this in next version.
quoted
+framework allows drivers to bind when corresponding devices report their
+presence on the bus.
+However, it is possible that the driver needs to be probed
+first so that it can enable corresponding SLIMbus device (e.g. power it up and/or
+take it out of reset). To support that behavior, the framework allows drivers
+to probe first as well  (e.g. using standard DeviceTree compatbility field).
Typo: s/compatbility/compatibility/
Yep, Will fix in next version.
quoted
+---------------
+The framework supports APIs to exchange control-information with a SLIMbus
+device. APIs can be synchronous or asynchronous.
+From controller's perspective, multiple buffers can be queued to/from
+hardware for sending/receiving data using slim_ctrl_buf circular buffer.
+The header file <linux/slimbus.h> has more documentation about messaging APIs.
Once the kerneldoc documentation (i.e. the /** ... */ comments in the
source) is included somewhere, I think it would make sense to make
slim_ctrl_buf a clickable link to the struct's documentation.
Sure, I will explore this side of it before i send next version.

thanks,
srini

Thanks,
Jonathan Neuschäfer
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help