Commit 7e527e11 authored by Tomas Winkler's avatar Tomas Winkler Committed by Greg Kroah-Hartman
Browse files

mei: docs: move documentation under driver-api 



Move mei driver documentation under Documentation/driver-api/
Perform some minimal formating changes to produce correct sphinx rendering
and add index.rst

Signed-off-by: default avatarTomas Winkler <tomas.winkler@intel.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 381e9760

Documentation/driver-api/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -42,6 +42,7 @@ available subsections can be seen below. 
   target

   mtdnand

   miscellaneous

   mei/index

   w1

   rapidio

   s390-drivers

Documentation/driver-api/mei/index.rst

0 → 100644
+22 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



.. include:: <isonum.txt>



===================================================

Intel(R) Management Engine Interface (Intel(R) MEI)

===================================================



**Copyright** |copy| 2019 Intel Corporation





.. only:: html



   .. class:: toc-title



        Table of Contents



.. toctree::

   :maxdepth: 2



   mei

   mei-client-bus

Documentation/misc-devices/mei/mei-client-bus.txt→Documentation/driver-api/mei/mei-client-bus.rst

+73 −62
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==============================================

Intel(R) Management Engine (ME) Client bus API

==============================================
@@ -22,7 +25,9 @@ MEI CL bus API 


A driver implementation for an MEI Client is very similar to existing bus

based device drivers. The driver registers itself as an MEI CL bus driver through

the mei_cl_driver structure:

the ``struct mei_cl_driver`` structure:



.. code-block:: C



        struct mei_cl_driver {

                struct device_driver driver;
@@ -61,6 +66,8 @@ Example 
As a theoretical example let's pretend the ME comes with a "contact" NFC IP.

The driver init and exit routines for this device would look like:



.. code-block:: C



	#define CONTACT_DRIVER_NAME "contact"



	static struct mei_cl_device_id contact_mei_cl_tbl[] = {
@@ -102,6 +109,8 @@ module_exit(contact_exit); 


And the driver's simplified probe routine would look like that:



.. code-block:: C



	int contact_probe(struct mei_cl_device *dev, struct mei_cl_device_id *id)

	{

		struct contact_driver *contact;
@@ -122,6 +131,8 @@ the pending events: 


#define MAX_NFC_PAYLOAD 128



.. code-block:: C



	static void contact_event_cb(struct mei_cl_device *dev, u32 events,

				     void *context)

	{

Documentation/misc-devices/mei/mei.txt→Documentation/driver-api/mei/mei.rst

+7 −23
Original line number Diff line number Diff line 
Intel(R) Management Engine Interface (Intel(R) MEI)

===================================================

.. SPDX-License-Identifier: GPL-2.0



Introduction

============
@@ -70,6 +69,8 @@ user to access it. 


A code snippet for an application communicating with Intel AMTHI client:



.. code-block:: C



	struct mei_connect_client_data data;

	fd = open(MEI_DEVICE);
@@ -93,8 +94,8 @@ A code snippet for an application communicating with Intel AMTHI client: 
	close(fd);





IOCTL

=====

IOCTLs

======



The Intel MEI Driver supports the following IOCTL commands:

	IOCTL_MEI_CONNECT_CLIENT	Connect to firmware Feature (client).
@@ -114,8 +115,7 @@ The Intel MEI Driver supports the following IOCTL commands: 


	error returns:

		EINVAL	Wrong IOCTL Number

		ENODEV	Device or Connection is not initialized or ready.

			(e.g. Wrong UUID)

		ENODEV	Device or Connection is not initialized or ready. (e.g. Wrong UUID)

		ENOMEM	Unable to allocate memory to client internal data.

		EFAULT	Fatal Error (e.g. Unable to access user input data)

		EBUSY	Connection Already Open
@@ -241,26 +241,10 @@ watchdog is 120 seconds. 
If the Intel AMT is not enabled in the firmware then the watchdog client won't enumerate

on the me client bus and watchdog devices won't be exposed.





Supported Chipsets

==================

82X38/X48 Express and newer



7 Series Chipset Family

6 Series Chipset Family

5 Series Chipset Family

4 Series Chipset Family

Mobile 4 Series Chipset Family

ICH9

82946GZ/GL

82G35 Express

82Q963/Q965

82P965/G965

Mobile PM965/GM965

Mobile GME965/GLE960

82Q35 Express

82G33/G31/P35/P31 Express

82Q33 Express

82X38/X48 Express



---

linux-mei@linux.intel.com

MAINTAINERS

+1 −1
Original line number Diff line number Diff line
@@ -8021,7 +8021,7 @@ F: include/uapi/linux/mei.h 
F:	include/linux/mei_cl_bus.h

F:	drivers/misc/mei/*

F:	drivers/watchdog/mei_wdt.c

F:	Documentation/misc-devices/mei/*

F:	Documentation/driver-api/mei/*

F:	samples/mei/*



INTEL MENLOW THERMAL DRIVER