Documentation/ABI/testing/sysfs-class-mic.txt

   1 What:           /sys/class/mic/
   2 Date:           August 2013
   3 KernelVersion:  3.11
   4 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
   5 Description:
   6                 The mic class directory belongs to Intel MIC devices and
   7                 provides information per MIC device. An Intel MIC device is a
   8                 PCIe form factor add-in Coprocessor card based on the Intel Many
   9                 Integrated Core (MIC) architecture that runs a Linux OS.
  10
  11 What:           /sys/class/mic/mic(x)
  12 Date:           August 2013
  13 KernelVersion:  3.11
  14 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  15 Description:
  16                 The directories /sys/class/mic/mic0, /sys/class/mic/mic1 etc.,
  17                 represent MIC devices (0,1,..etc). Each directory has
  18                 information specific to that MIC device.
  19
  20 What:           /sys/class/mic/mic(x)/family
  21 Date:           August 2013
  22 KernelVersion:  3.11
  23 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  24 Description:
  25                 Provides information about the Coprocessor family for an Intel
  26                 MIC device. For example - "x100"
  27
  28 What:           /sys/class/mic/mic(x)/stepping
  29 Date:           August 2013
  30 KernelVersion:  3.11
  31 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  32 Description:
  33                 Provides information about the silicon stepping for an Intel
  34                 MIC device. For example - "A0" or "B0"
  35
  36 What:           /sys/class/mic/mic(x)/state
  37 Date:           August 2013
  38 KernelVersion:  3.11
  39 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  40 Description:
  41                 When read, this entry provides the current state of an Intel
  42                 MIC device in the context of the card OS. Possible values that
  43                 will be read are:
  44                 "offline" - The MIC device is ready to boot the card OS.
  45                 "online" - The MIC device has initiated booting a card OS.
  46                 "shutting_down" - The card OS is shutting down.
  47                 "reset_failed" - The MIC device has failed to reset.
  48
  49                 When written, this sysfs entry triggers different state change
  50                 operations depending upon the current state of the card OS.
  51                 Acceptable values are:
  52                 "boot" - Boot the card OS image specified by the combination
  53                          of firmware, ramdisk, cmdline and bootmode
  54                         sysfs entries.
  55                 "reset" - Initiates device reset.
  56                 "shutdown" - Initiates card OS shutdown.
  57
  58 What:           /sys/class/mic/mic(x)/shutdown_status
  59 Date:           August 2013
  60 KernelVersion:  3.11
  61 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  62 Description:
  63                 An Intel MIC device runs a Linux OS during its operation. This
  64                 OS can shutdown because of various reasons. When read, this
  65                 entry provides the status on why the card OS was shutdown.
  66                 Possible values are:
  67                 "nop" -  shutdown status is not applicable, when the card OS is
  68                         "online"
  69                 "crashed" - Shutdown because of a HW or SW crash.
  70                 "halted" - Shutdown because of a halt command.
  71                 "poweroff" - Shutdown because of a poweroff command.
  72                 "restart" - Shutdown because of a restart command.
  73
  74 What:           /sys/class/mic/mic(x)/cmdline
  75 Date:           August 2013
  76 KernelVersion:  3.11
  77 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  78 Description:
  79                 An Intel MIC device runs a Linux OS during its operation. Before
  80                 booting this card OS, it is possible to pass kernel command line
  81                 options to configure various features in it, similar to
  82                 self-bootable machines. When read, this entry provides
  83                 information about the current kernel command line options set to
  84                 boot the card OS. This entry can be written to change the
  85                 existing kernel command line options. Typically, the user would
  86                 want to read the current command line options, append new ones
  87                 or modify existing ones and then write the whole kernel command
  88                 line back to this entry.
  89
  90 What:           /sys/class/mic/mic(x)/firmware
  91 Date:           August 2013
  92 KernelVersion:  3.11
  93 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
  94 Description:
  95                 When read, this sysfs entry provides the path name under
  96                 /lib/firmware/ where the firmware image to be booted on the
  97                 card can be found. The entry can be written to change the
  98                 firmware image location under /lib/firmware/.
  99
 100 What:           /sys/class/mic/mic(x)/ramdisk
 101 Date:           August 2013
 102 KernelVersion:  3.11
 103 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
 104 Description:
 105                 When read, this sysfs entry provides the path name under
 106                 /lib/firmware/ where the ramdisk image to be used during card
 107                 OS boot can be found. The entry can be written to change
 108                 the ramdisk image location under /lib/firmware/.
 109
 110 What:           /sys/class/mic/mic(x)/bootmode
 111 Date:           August 2013
 112 KernelVersion:  3.11
 113 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
 114 Description:
 115                 When read, this sysfs entry provides the current bootmode for
 116                 the card. This sysfs entry can be written with the following
 117                 valid strings:
 118                 a) linux - Boot a Linux image.
 119                 b) elf - Boot an elf image for flash updates.
 120
 121 What:           /sys/class/mic/mic(x)/log_buf_addr
 122 Date:           August 2013
 123 KernelVersion:  3.11
 124 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
 125 Description:
 126                 An Intel MIC device runs a Linux OS during its operation. For
 127                 debugging purpose and early kernel boot messages, the user can
 128                 access the card OS log buffer via debugfs. When read, this entry
 129                 provides the kernel virtual address of the buffer where the card
 130                 OS log buffer can be read. This entry is written by the host
 131                 configuration daemon to set the log buffer address. The correct
 132                 log buffer address to be written can be found in the System.map
 133                 file of the card OS.
 134
 135 What:           /sys/class/mic/mic(x)/log_buf_len
 136 Date:           August 2013
 137 KernelVersion:  3.11
 138 Contact:        Sudeep Dutt <sudeep.dutt@intel.com>
 139 Description:
 140                 An Intel MIC device runs a Linux OS during its operation. For
 141                 debugging purpose and early kernel boot messages, the user can
 142                 access the card OS log buffer via debugfs. When read, this entry
 143                 provides the kernel virtual address where the card OS log buffer
 144                 length can be read. This entry is written by host configuration
 145                 daemon to set the log buffer length address. The correct log
 146                 buffer length address to be written can be found in the
 147                 System.map file of the card OS.