Linux Documentation
 help / color / mirror / Atom feed
From: kernel test robot <lkp@intel.com>
To: Pankaj Gupta <pankaj.gupta@nxp.com>
Cc: oe-kbuild-all@lists.linux.dev, Frank Li <Frank.Li@nxp.com>,
	linux-doc@vger.kernel.org
Subject: [frank-li:for-next 1/53] htmldocs: Documentation/driver-api/firmware/other_interfaces.rst:116: WARNING: Blank line required after table. [docutils]
Date: Wed, 06 May 2026 00:40:44 +0200	[thread overview]
Message-ID: <202605060054.EQwFXknk-lkp@intel.com> (raw)

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/frank.li/linux.git for-next
head:   2dfb59f50bc1e1600fa1be5a97a21185306f5f78
commit: 3b4531c6e0f4c8874f0266853a410438eda1fc24 [1/53] Documentation/firmware: add imx/se to other_interfaces
compiler: clang version 20.1.8 (https://github.com/llvm/llvm-project 87f0227cb60147a26a1eeb4fb06e3b505e9c7261)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)
reproduce: (https://download.01.org/0day-ci/archive/20260506/202605060054.EQwFXknk-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202605060054.EQwFXknk-lkp@intel.com/

All warnings (new ones prefixed by >>):

   Documentation/driver-api/basics:42: ./kernel/time/time.c:393: WARNING: Duplicate C declaration, also defined at driver-api/basics:453.
   Declaration is '.. c:function:: unsigned int jiffies_to_usecs (const unsigned long j)'. [duplicate_declaration.c]
   Documentation/driver-api/firmware/other_interfaces.rst:60: ERROR: Unexpected indentation. [docutils]
   Documentation/driver-api/firmware/other_interfaces.rst:103: ERROR: Unexpected indentation. [docutils]
   Documentation/driver-api/firmware/other_interfaces.rst:115: ERROR: Unexpected indentation. [docutils]
>> Documentation/driver-api/firmware/other_interfaces.rst:116: WARNING: Blank line required after table. [docutils]
>> Documentation/driver-api/firmware/other_interfaces.rst:140: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils]
   ERROR: Cannot find file ./drivers/firmware/imx/se_ctrl.c
   ERROR: Cannot find file ./drivers/firmware/imx/se_ctrl.c
   WARNING: No kernel-doc for file ./drivers/firmware/imx/se_ctrl.c
   Documentation/driver-api/target:25: ./drivers/target/target_core_user.c:35: ERROR: Unexpected section title.


vim +116 Documentation/driver-api/firmware/other_interfaces.rst

    94	
    95	::
    96	   +--------------------------------------------+
    97	   |            Character Device(C_DEV)         |
    98	   |                                            |
    99	   |   +---------+ +---------+     +---------+  |
   100	   |   | misc #1 | | misc #2 | ... | misc #n |  |
   101	   |   |  dev    | |  dev    |     | dev     |  |
   102	   |   +---------+ +---------+     +---------+  |
   103	   |        +-------------------------+         |
   104	   |        | Misc. Dev Synchr. Logic |         |
   105	   |        +-------------------------+         |
   106	   |                                            |
   107	   +--------------------------------------------+
   108	
   109	   +--------------------------------------------+
   110	   |               Service Layer                |
   111	   |                                            |
   112	   |      +-----------------------------+       |
   113	   |      | Message Serialization Logic |       |
   114	   |      +-----------------------------+       |
   115	   |          +---------------+                 |
 > 116	   |          |  imx-mailbox  |                 |
   117	   |          |   mailbox.c   |                 |
   118	   |          +---------------+                 |
   119	   |                                            |
   120	   +--------------------------------------------+
   121	
   122	- service layer:
   123	  This layer is responsible for ensuring the communication protocol that is defined
   124	  for communication with firmware.
   125	
   126	  FW Communication protocol ensures two things:
   127	  - Serializing the messages to be sent over an MU.
   128	
   129	  - FW can handle one command message at a time.
   130	
   131	- c_dev:
   132	  This layer offers character device contexts, created as '/dev/<se>_mux_chx'.
   133	  Using these multiple device contexts that are getting multiplexed over a single MU,
   134	  userspace application(s) can call fops like write/read to send the command message,
   135	  and read back the command response message to/from Firmware.
   136	  fops like read & write use the above defined service layer API(s) to communicate with
   137	  Firmware.
   138	
   139	  Misc-device(/dev/<se>_mux_chn) synchronization protocol:
 > 140	::
   141	
   142	                                Non-Secure               +   Secure
   143	                                                         |
   144	                                                         |
   145	                +-----------+      +-------------+       |
   146	                | se_ctrl.c +<---->+imx-mailbox.c|       |
   147	                |           |      |  mailbox.c  +<-->+------+    +------+
   148	                +-----+-----+      +-------------+    | MU X +<-->+ ELE |
   149	                      |                               +------+    +------+
   150	                      +----------------+                 |
   151	                      |                |                 |
   152	                      v                v                 |
   153	                  logical           logical              |
   154	                  receiver          waiter               |
   155	                     +                 +                 |
   156	                     |                 |                 |
   157	                     |                 |                 |
   158	                     |            +----+------+          |
   159	                     |            |           |          |
   160	                     |            |           |          |
   161	              device_ctx     device_ctx     device_ctx   |
   162	                                                         |
   163	                User 0        User 1       User Y        |
   164	                +------+      +------+     +------+      |
   165	                |misc.c|      |misc.c|     |misc.c|      |
   166	 kernel space   +------+      +------+     +------+      |
   167	                                                         |
   168	 +------------------------------------------------------ |
   169	                    |             |           |          |
   170	 userspace     /dev/ele_muXch0    |           |          |
   171	                          /dev/ele_muXch1     |          |
   172	                                        /dev/ele_muXchY  |
   173	                                                         |
   174	

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

                 reply	other threads:[~2026-05-05 22:41 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=202605060054.EQwFXknk-lkp@intel.com \
    --to=lkp@intel.com \
    --cc=Frank.Li@nxp.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=oe-kbuild-all@lists.linux.dev \
    --cc=pankaj.gupta@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox