Message-Id: <cover.1374717252.git.sudeep.dutt@intel.com>
Date:	Wed, 24 Jul 2013 20:31:31 -0700
From:	Sudeep Dutt <sudeep.dutt@...el.com>
To:	Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
	Arnd Bergmann <arnd@...db.de>,
	Rusty Russell <rusty@...tcorp.com.au>,
	"Michael S. Tsirkin" <mst@...hat.com>,
	Rob Landley <rob@...dley.net>, linux-kernel@...r.kernel.org,
	virtualization@...ts.linux-foundation.org,
	linux-doc@...r.kernel.org
Cc:	Nikhil Rao <nikhil.rao@...el.com>,
	Ashutosh Dixit <ashutosh.dixit@...el.com>,
	Caz Yokoyama <Caz.Yokoyama@...el.com>,
	Dasaratharaman Chandramouli 
	<dasaratharaman.chandramouli@...el.com>,
	Harshavardhan R Kharche <harshavardhan.r.kharche@...el.com>,
	"Yaozu (Eddie) Dong" <eddie.dong@...el.com>,
	Peter P Waskiewicz Jr <peter.p.waskiewicz.jr@...el.com>,
	Sudeep Dutt <sudeep.dutt@...el.com>
Subject: [PATCH 0/5] Enable Drivers for Intel MIC X100 Coprocessors.

An Intel MIC X100 device is a PCIe form factor add-in coprocessor
card based on the Intel Many Integrated Core (MIC) architecture
that runs a Linux OS. It is a PCIe endpoint in a platform and therefore
implements the three required standard address spaces i.e. configuration,
memory and I/O. The host OS loads a device driver as is typical for
PCIe devices. The card itself runs a bootstrap after reset that
transfers control to the card OS downloaded from the host driver.
The card OS as shipped by Intel is a Linux kernel with modifications
for the X100 devices.

Since it is a PCIe card, it does not have the ability to host hardware
devices for networking, storage and console. We provide these devices
on X100 coprocessors thus enabling a self-bootable equivalent environment
for applications. A key benefit of our solution is that it leverages
the standard virtio framework for network, disk and console devices,
though in our case the virtio framework is used across a PCIe bus.

Here is a block diagram of the various components described above. The
virtio backends are situated on the host rather than the card given better
single threaded performance for the host compared to MIC and the ability of
the host to initiate DMA's to/from the card using the MIC DMA engine.

                              |
       +----------+           |             +----------+
       | Card OS  |           |             | Host OS  |
       +----------+           |             +----------+
                              |
+-------+ +--------+ +------+ | +---------+  +--------+ +--------+
| Virtio| |Virtio  | |Virtio| | |Virtio   |  |Virtio  | |Virtio  |
| Net   | |Console | |Block | | |Net      |  |Console | |Block   |
| Driver| |Driver  | |Driver| | |backend  |  |backend | |backend |
+-------+ +--------+ +------+ | +---------+  +--------+ +--------+
    |         |         |     |      |            |         |
    |         |         |     |Ring 3|            |         |
    |         |         |     |------|------------|---------|-------
    +-------------------+     |Ring 0+--------------------------+
              |               |      | Virtio over PCIe IOCTLs  |
              |               |      +--------------------------+
      +--------------+        |                   |
      |Intel MIC     |        |            +---------------+
      |Card Driver   |        |            |Intel MIC      |
      +--------------+        |            |Host Driver    |
              |               |            +---------------+
              |               |                   |
     +-------------------------------------------------------------+
     |                                                             |
     |                    PCIe Bus                                 |
     +-------------------------------------------------------------+

The following series of patches are partitioned as follows:

Patch 1: This patch introduces the "Intel MIC Host Driver" in the block
diagram which does the following:
a) Initializes the Intel MIC X100 PCIe devices.
b) Boots and shuts down the card via sysfs entries.
c) Allocates and maps a device page for communication with the
card driver and updates the device page address via scratchpad
registers.
d) Provides sysfs entries for family, stepping, state, shutdown
status, kernel command line, IP address, ramdisk and log buffer
information.

Patch 2: This patch introduces the "Intel MIC Card Driver" in the block
diagram which does the following:
a) Initializes the Intel MIC X100 platform device and driver.
b) Sets up support to handle shutdown requests from the host.
c) Maps the device page after obtaining the device page address
from the scratchpad registers updated by the host.
d) Informs the host upon a card crash by registering a panic notifier.
e) Informs the host upon a poweroff/halt event.

Patch 3: This patch introduces the host "Virtio over PCIe" interface for
Intel MIC. It allows creating user space backends on the host and
instantiating virtio devices for them on the Intel MIC card. A character
device per MIC is exposed with IOCTL, mmap and poll callbacks. This allows
the user space backend to:
(a) add/remove a virtio device via a device page.
(b) map (R/O) virtio rings and device page to user space.
(c) poll for availability of data.
(d) copy a descriptor or entire descriptor chain to/from the card.
(e) modify virtio configuration.
(f) handle virtio device reset.
The buffers are copied over using CPU copies for this initial patch
and host initiated MIC DMA support is planned for future patches.
The avail and desc virtio rings are in host memory and the used ring
is in card memory to maximize writes across PCIe for performance.

Patch 4: This patch introduces the card "Virtio over PCIe" interface for
Intel MIC. It allows virtio drivers on the card to communicate with their
user space backends on the host via a device page. Ring 3 apps on the host
can add, remove and configure virtio devices. A thin MIC specific
virtio_config_ops is implemented which is borrowed heavily from previous
similar implementations in lguest and s390 @
drivers/lguest/lguest_device.c
drivers/s390/kvm/kvm_virtio.c

Patch 5: This patch introduces a sample user space daemon which
implements the virtio device backends on the host. The daemon
creates/removes/configures virtio device backends by communicating with
the Intel MIC Host Driver. The virtio devices currently supported are
virtio net, virtio console and virtio block. The daemon also monitors
card shutdown status and takes appropriate actions like killing the
virtio backends and resetting the card upon card shutdown and crashes.

The patches have been compiled/validated against v3.10.

Ashutosh Dixit (2):
  Intel MIC Host Driver Changes for Virtio Devices.
  Intel MIC Card Driver Changes for Virtio Devices.

Caz Yokoyama (1):
  Sample Implementation of Intel MIC User Space Daemon.

Sudeep Dutt (2):
  Intel MIC Host Driver for X100 family.
  Intel MIC Card Driver for X100 family.

 Documentation/mic/mic_overview.txt   |   48 +
 Documentation/mic/mpssd/.gitignore   |    1 +
 Documentation/mic/mpssd/Makefile     |   20 +
 Documentation/mic/mpssd/micctrl      |  157 +++
 Documentation/mic/mpssd/mpss         |  246 +++++
 Documentation/mic/mpssd/mpssd.c      | 1732 ++++++++++++++++++++++++++++++++++
 Documentation/mic/mpssd/mpssd.h      |  105 +++
 Documentation/mic/mpssd/sysfs.c      |  108 +++
 drivers/misc/Kconfig                 |    1 +
 drivers/misc/Makefile                |    1 +
 drivers/misc/mic/Kconfig             |   56 ++
 drivers/misc/mic/Makefile            |    6 +
 drivers/misc/mic/card/Makefile       |   11 +
 drivers/misc/mic/card/mic_common.h   |   43 +
 drivers/misc/mic/card/mic_debugfs.c  |  139 +++
 drivers/misc/mic/card/mic_debugfs.h  |   40 +
 drivers/misc/mic/card/mic_device.c   |  311 ++++++
 drivers/misc/mic/card/mic_device.h   |  106 +++
 drivers/misc/mic/card/mic_virtio.c   |  643 +++++++++++++
 drivers/misc/mic/card/mic_virtio.h   |   79 ++
 drivers/misc/mic/card/mic_x100.c     |  253 +++++
 drivers/misc/mic/card/mic_x100.h     |   53 ++
 drivers/misc/mic/common/mic_device.h |   85 ++
 drivers/misc/mic/host/Makefile       |   13 +
 drivers/misc/mic/host/mic_boot.c     |  181 ++++
 drivers/misc/mic/host/mic_common.h   |   37 +
 drivers/misc/mic/host/mic_debugfs.c  |  503 ++++++++++
 drivers/misc/mic/host/mic_debugfs.h  |   34 +
 drivers/misc/mic/host/mic_device.h   |  280 ++++++
 drivers/misc/mic/host/mic_fops.c     |  280 ++++++
 drivers/misc/mic/host/mic_fops.h     |   37 +
 drivers/misc/mic/host/mic_main.c     | 1119 ++++++++++++++++++++++
 drivers/misc/mic/host/mic_smpt.c     |  441 +++++++++
 drivers/misc/mic/host/mic_smpt.h     |  103 ++
 drivers/misc/mic/host/mic_sysfs.c    |  360 +++++++
 drivers/misc/mic/host/mic_virtio.c   |  703 ++++++++++++++
 drivers/misc/mic/host/mic_virtio.h   |  108 +++
 drivers/misc/mic/host/mic_x100.c     |  665 +++++++++++++
 drivers/misc/mic/host/mic_x100.h     |  112 +++
 include/uapi/linux/Kbuild            |    2 +
 include/uapi/linux/mic_common.h      |  242 +++++
 include/uapi/linux/mic_ioctl.h       |  104 ++
 42 files changed, 9568 insertions(+)
 create mode 100644 Documentation/mic/mic_overview.txt
 create mode 100644 Documentation/mic/mpssd/.gitignore
 create mode 100644 Documentation/mic/mpssd/Makefile
 create mode 100755 Documentation/mic/mpssd/micctrl
 create mode 100755 Documentation/mic/mpssd/mpss
 create mode 100644 Documentation/mic/mpssd/mpssd.c
 create mode 100644 Documentation/mic/mpssd/mpssd.h
 create mode 100644 Documentation/mic/mpssd/sysfs.c
 create mode 100644 drivers/misc/mic/Kconfig
 create mode 100644 drivers/misc/mic/Makefile
 create mode 100644 drivers/misc/mic/card/Makefile
 create mode 100644 drivers/misc/mic/card/mic_common.h
 create mode 100644 drivers/misc/mic/card/mic_debugfs.c
 create mode 100644 drivers/misc/mic/card/mic_debugfs.h
 create mode 100644 drivers/misc/mic/card/mic_device.c
 create mode 100644 drivers/misc/mic/card/mic_device.h
 create mode 100644 drivers/misc/mic/card/mic_virtio.c
 create mode 100644 drivers/misc/mic/card/mic_virtio.h
 create mode 100644 drivers/misc/mic/card/mic_x100.c
 create mode 100644 drivers/misc/mic/card/mic_x100.h
 create mode 100644 drivers/misc/mic/common/mic_device.h
 create mode 100644 drivers/misc/mic/host/Makefile
 create mode 100644 drivers/misc/mic/host/mic_boot.c
 create mode 100644 drivers/misc/mic/host/mic_common.h
 create mode 100644 drivers/misc/mic/host/mic_debugfs.c
 create mode 100644 drivers/misc/mic/host/mic_debugfs.h
 create mode 100644 drivers/misc/mic/host/mic_device.h
 create mode 100644 drivers/misc/mic/host/mic_fops.c
 create mode 100644 drivers/misc/mic/host/mic_fops.h
 create mode 100644 drivers/misc/mic/host/mic_main.c
 create mode 100644 drivers/misc/mic/host/mic_smpt.c
 create mode 100644 drivers/misc/mic/host/mic_smpt.h
 create mode 100644 drivers/misc/mic/host/mic_sysfs.c
 create mode 100644 drivers/misc/mic/host/mic_virtio.c
 create mode 100644 drivers/misc/mic/host/mic_virtio.h
 create mode 100644 drivers/misc/mic/host/mic_x100.c
 create mode 100644 drivers/misc/mic/host/mic_x100.h
 create mode 100644 include/uapi/linux/mic_common.h
 create mode 100644 include/uapi/linux/mic_ioctl.h

-- 
1.8.2.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Powered by blists - more mailing lists