├── docs
    ├── accel-config-save-config.md
    ├── accel-config-enable-device.md
    ├── accel-config-enable-wq.md
    ├── accel-config-disable-device.md
    ├── accel-config-disable-wq.md
    ├── accel-config-config-engine.md
    ├── accel-config-config-device.md
    ├── index.md
    ├── accel-config-load-config.md
    ├── accel-config-config-group.md
    ├── accel-config.md
    ├── accel-config-config-wq.md
    ├── index.html
    └── accel-config-list.md
├── README.md
└── index.html


/docs/accel-config-save-config.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-save-config - save the configuration in json format into a
 6 | file.
 7 | 
 8 | SYNOPSIS
 9 | ========
10 | 
11 | >     accel-config save-config [<options>]
12 | 
13 | Save the current configuration displayed in json format into a specified
14 | path with specified file name.
15 | 
16 | EXAMPLE
17 | =======
18 | 
19 |     # accel-config save-config -s /usr/accfg/save_config.conf
20 | 
21 | OPTIONS
22 | =======
23 | 
24 | `-s; --saved-file=`  
25 | to specify saved file name and path
26 | 


--------------------------------------------------------------------------------
/docs/accel-config-enable-device.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-enable-device - enable an accfg device
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config enable-device <device>
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config enable-device dsa0
16 | 
17 | COPYRIGHT
18 | =========
19 | 
20 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
21 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
22 | are free to change and redistribute it. There is NO WARRANTY, to the
23 | extent permitted by law.
24 | 
25 | SEE ALSO
26 | ========
27 | 
28 | linkaccel-config:[accel-config-disable-device](accel-config-disable-device.md)
29 | 


--------------------------------------------------------------------------------
/docs/accel-config-enable-wq.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-enable-wq - enables an accelerator device work queue
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config enable-wq <device_name>/<workqueue_name>
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config enable-wq dsa0/wq0.0
16 | 
17 | COPYRIGHT
18 | =========
19 | 
20 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
21 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
22 | are free to change and redistribute it. There is NO WARRANTY, to the
23 | extent permitted by law.
24 | 
25 | SEE ALSO
26 | ========
27 | 
28 | linkaccel-config:[accel-config-disable-wq](accel-config-disable-wq.md)
29 | 


--------------------------------------------------------------------------------
/docs/accel-config-disable-device.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-disable-device - disables an accfg device
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config disable-device <device>
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config disable-device dsa0
16 | 
17 | OPTIONS
18 | =======
19 | -f::
20 | --force::
21 | 	Force the disable of device even when there are clients using the
22 | 	device.
23 |   
24 | COPYRIGHT
25 | =========
26 | 
27 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
28 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
29 | are free to change and redistribute it. There is NO WARRANTY, to the
30 | extent permitted by law.
31 | 
32 | SEE ALSO
33 | ========
34 | 
35 | linkaccel-config:[accel-config-enable-device](accel-config-enable-device.md)
36 | 


--------------------------------------------------------------------------------
/docs/accel-config-disable-wq.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-disable-wq - disables an accelerator device work queue
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config disable-wq <device name>/<work queue>
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config disable-wq dsa0/wq0.0
16 | 
17 | OPTIONS
18 | =======
19 | -f::
20 | --force::
21 | 	Force the disabling of the wq even if there are clients using the wq.
22 | 
23 | COPYRIGHT
24 | =========
25 | 
26 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
27 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
28 | are free to change and redistribute it. There is NO WARRANTY, to the
29 | extent permitted by law.
30 | 
31 | SEE ALSO
32 | ========
33 | 
34 | linkaccel-config:[accel-config-enable-wq](accel-config-enable-wq.md)
35 | 


--------------------------------------------------------------------------------
/docs/accel-config-config-engine.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-config-engine - configure individual attributes of an
 6 | engine
 7 | 
 8 | SYNOPSIS
 9 | ========
10 | 
11 | >     accel-config config-engine <device name>/<engine name> [<options>]
12 | 
13 | EXAMPLE
14 | =======
15 | 
16 | accel-config config-engine dsa0/engine1.2 --group-id=0
17 | 
18 | OPTIONS
19 | =======
20 | 
21 | `-g; --group-id=`  
22 | specify the group-id for this engine, group-id should be between 0 and
23 | the maximum number of groups per device shown in max\_groups attribute
24 | under a device. A value of -1 disassociates the engine from any group.
25 | 
26 | COPYRIGHT
27 | =========
28 | 
29 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
30 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
31 | are free to change and redistribute it. There is NO WARRANTY, to the
32 | extent permitted by law.
33 | 


--------------------------------------------------------------------------------
/docs/accel-config-config-device.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-config-device - configure the individual attributes of the
 6 | device
 7 | 
 8 | SYNOPSIS
 9 | ========
10 | 
11 | >     accel-config config-device <device name> [<options>]
12 | 
13 | EXAMPLE
14 | =======
15 | 
16 | accel-config config-device dsa0 --token-limit=1
17 | 
18 | OPTIONS
19 | =======
20 | 
21 | `-l; --token-limit=`
22 | This specifies the maximum number of bandwidth tokens that may be in use
23 | at one time by operations that access low bandwidth memory. This number
24 | of bandwidth tokens is shared by all descriptors accessing low bandwidth
25 | memory across the entire device. token_limit should be more than 0.
26 | 
27 | COPYRIGHT
28 | =========
29 | 
30 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
31 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
32 | are free to change and redistribute it. There is NO WARRANTY, to the
33 | extent permitted by law.
34 | 


--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | Title: accel-config
 3 | 
 4 | ---
 5 | [View the Project on GitHub](https://github.com/intel/idxd-config)  
 6 |  
 7 | ---
 8 | #### accel-config man pages
 9 | * [accel-config](accel-config.md)
10 | * [accel-config-config-device](accel-config-config-device.md)
11 | * [accel-config-config-engine](accel-config-config-engine.md)
12 | * [accel-config-config-group](accel-config-config-group.md)
13 | * [accel-config-config-wq](accel-config-config-wq.md)
14 | * [accel-config-create-mdev](accel-config-create-mdev.md)
15 | * [accel-config-disable-device](accel-config-disable-device.md)
16 | * [accel-config-disable-wq](accel-config-disable-wq.md)
17 | * [accel-config-enable-device](accel-config-enable-device.md)
18 | * [accel-config-enable-wq](accel-config-enable-wq.md)
19 | * [accel-config-list](accel-config-list.md)
20 | * [accel-config-load-config](accel-config-load-config.md)
21 | * [accel-config-remove-mdev](accel-config-remove-mdev.md)
22 | * [accel-config-save-config](accel-config-save-config.md)
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | DISCONTINUATION OF PROJECT
 2 | 
 3 | This project will no longer be maintained by Intel.
 4 | 
 5 | Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.  
 6 | 
 7 | Intel no longer accepts patches to this project.
 8 | 
 9 | If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the open source software community, please create your own fork of this project.  
10 | 
11 | Contact: webadmin@linux.intel.com
12 | # Intel® Data Accelerator Driver
13 | 
14 | The kernel driver Intel® Data Accelerator Driver (IDXD)  is a typical kernel driver that identifies devices instances in a system. This is also a component referred to in the Intel® Scalable IOV specification as the Virtual Device Composition Module (VDCM) that creates instances to facilitate exposing a virtual Intel® DSA instance to a guest OS.
15 | 
16 | accel-config is a utility that allows system administrators to configure groups, workqueues and engines. The utility parses the topology and capabilities exposed via sysfs and provides a command line interface to configure resources.
17 | 


--------------------------------------------------------------------------------
/docs/accel-config-load-config.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-load-config - load pre-defined the configuration in json
 6 | format
 7 | 
 8 | SYNOPSIS
 9 | ========
10 | 
11 | >     accel-config load-config [<options>]
12 | 
13 | Load and scan through the pre-defined configuration file in json format,
14 | and set the configured attribute into corresponding component.
15 | 
16 | There is a sample config file at
17 | /etc/accel-config/accel-config.conf.sample, and it can be used as a
18 | reference for user about how the loadable config file looks like, but it
19 | should not be used directly given the variance of each system. The user
20 | should create a proper config file according to the format of sample
21 | file and use "-c" option to point to the config file.
22 | 
23 | EXAMPLE
24 | =======
25 | 
26 |     # accel-config load-config
27 |     The command will load the default config file at
28 |     /etc/accel-config/accel-config.conf
29 | 
30 |     # accel-config load-config -c <my_config.conf>
31 |     The command will load the specified config file
32 | 
33 | OPTIONS
34 | =======
35 | 
36 | `-l; --log=`  
37 | to set where to output the config’s notification
38 | 
39 | `-c; --config-file`  
40 | to specify the location of the customized config file
41 | 


--------------------------------------------------------------------------------
/docs/accel-config-config-group.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-config-group - configure individual attributes of a group
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config config-group <device name>/<group name> [<options>]
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config config-group dsa0/group0.0 --tokens-reserved=1
16 | 
17 | OPTIONS
18 | =======
19 | 
20 | `-r; --tokens-reserved=`  
21 | specify the number of badwdith tokens reserved for the use of engines in
22 | the group. The limit of this value must be:
23 | 
24 | -   The sum of all tokens-reserved for all groups must be less than or
25 |     equal to total badwidth tokens from group capability field of the
26 |     device.
27 | 
28 | `-t; --tokens-allowed=`  
29 | specify the maxinum number of bandwidth tokens that may be in use at one
30 | time by all engines in the group. This value can be used to limit the
31 | maximum bandwidth used by engines in the group. The limit of this value
32 | must be:
33 | 
34 | -   greater than 0
35 | 
36 | -   greater than or equal to the tokens-reserved value for this group.
37 | 
38 | -   less than or equal to the sum of tokens reserved field and the
39 |     non-reserved bandwidth tokens (total bandwidth tokens - total
40 |     tokens-reserved for all groups).
41 | 
42 | `-l; --use-token-limit=`  
43 | toggle the enabling of token limt usage. use-token-limit should be
44 | either 0 or 1.
45 | 
46 | `-a; --traffic-class-a=`  
47 | specify traffic class A for this group, it should be larger than 0 and
48 | less than 8.
49 | 
50 | `-b; --traffic-class-b=`  
51 | specify traffic class B for this group, it should be larger than 0 and
52 | less than 8.
53 | 
54 | COPYRIGHT
55 | =========
56 | 
57 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
58 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
59 | are free to change and redistribute it. There is NO WARRANTY, to the
60 | extent permitted by law.
61 | 


--------------------------------------------------------------------------------
/docs/accel-config.md:
--------------------------------------------------------------------------------
 1 | NAME
 2 | ====
 3 | 
 4 | accel-config - configure and control DSA(data streaminng accelerator)
 5 | subsystem devices
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config [--version] [--help] [OPTIONS] COMMAND [ARGS]
11 | 
12 | OPTIONS
13 | =======
14 | 
15 | `-v; --version`  
16 | Display accel-config version.
17 | 
18 | `-h; --help`  
19 | Run accel-config help command.
20 | 
21 | DESCRIPTION
22 | ===========
23 | 
24 | accel-config provides ability to display the accelerator’s state
25 | presented by the Linux driver via sysfs, configure the device via sysfs,
26 | and saving and loading the configuration.
27 | 
28 | COPYRIGHT
29 | =========
30 | 
31 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
32 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
33 | are free to change and redistribute it. There is NO WARRANTY, to the
34 | extent permitted by law.
35 | 
36 | SEE ALSO
37 | ========
38 | 
39 | linkaccel-config:[accel-config-enable-wq](accel-config-enable-wq.md),
40 | linkaccel-config:[accel-config-disable-wq](accel-config-disable-wq.md),
41 | linkaccel-config:[accel-config-enable-device](accel-config-enable-device.md),
42 | linkaccel-config:[accel-config-disable-device](accel-config-disable-device.md),
43 | linkaccel-config:[accel-config-load-config](accel-config-load-config.md),
44 | linkaccel-config:[accel-config-save-config](accel-config-save-config.md),
45 | linkaccel-config:[accel-config-list](accel-config-list.md),
46 | linkaccel-config:[accel-config-config-device](accel-config-config-device.md),
47 | linkaccel-config:[accel-config-config-group](accel-config-config-group.md),
48 | linkaccel-config:[accel-config-config-wq](accel-config-config-wq.md),
49 | linkaccel-config:[accel-config-config-engine](accel-config-config-engine.md),
50 | linkaccel-config:[accel-config-create-mdev](accel-config-create-mdev.md),
51 | linkaccel-config:[accel-config-remove-mdev](accel-config-remove-mdev.md),
52 | 


--------------------------------------------------------------------------------
/docs/accel-config-config-wq.md:
--------------------------------------------------------------------------------
 1 | 
 2 | NAME
 3 | ====
 4 | 
 5 | accel-config-config-wq - configure individual attributes of a work queue
 6 | 
 7 | SYNOPSIS
 8 | ========
 9 | 
10 | >     accel-config config-wq <device name>/<wq name> [<options>]
11 | 
12 | EXAMPLE
13 | =======
14 | 
15 | accel-config config-devie dsa0/wq0.0 --wq-size=16
16 | 
17 | OPTIONS
18 | =======
19 | 
20 | `-g; --group-id=`  
21 | specify the group id used by work queue, group id should be between 0
22 | and the maximum number of groups per device. A group id of -1
23 | disassociates the work queue from a group.
24 | 
25 | `-s; --wq-size=`  
26 | specify work queue size used by a work queue. The wq-size should be
27 | between 0 and the maximum workqueue size exposed by the device in the
28 | max\_work\_queue\_size attribute under device.
29 | 
30 | `-p; --priority`  
31 | specify the priority of this work queue relative to other work queues in
32 | the same group. This field ranges from 1 to 15 where the larger value
33 | means higher priority. For example, if wq1 has a priority of 6 and wq2
34 | has priority of 2, wq1 will issue 3 times as many descriptors to the
35 | engine compare to wq2.
36 | 
37 | `-b; --block-on-fault`  
38 | toggle block on fault enable for the work queue. block-on-fault should
39 | be either 0 or 1. If block on fault is disabled, if a page fault occurs
40 | on a source or destination memory access, the operation stops and the
41 | page fault is reported to the software.
42 | 
43 | `-t; --threshold`  
44 | configure the threshold for the wq. The set up threshold value should be
45 | larger than 0 and only for "shared" wq, and note that the configured
46 | threshold value should be at least 1 less than the configured wq-size
47 | value. The reason is threshold is set for unprivileged users, and need
48 | to reserve at least 1 space for the privileged user for commands.
49 | 
50 | `-y; --type`  
51 | configure the type for the wq. The wq type can be "kernel" for kernel
52 | user case to request wq, "mdev" for mediated device driver use case to
53 | request wq or "user" for regular character device driver use case to wq.
54 | 
55 | `-m; --mode`  
56 | configure the mode for the wq. The wq mode can be set as "dedicated" or
57 | "shared".
58 | 
59 | `-c; --max-batch-size`
60 | specify the max batch size used by a work queue. The value should be
61 | between 1 and the device maximum batch size found in the
62 | max\_batch\_size attribute under device. If the value is not a power
63 | of 2, it will be rounded up to the next power of 2.
64 | 
65 | `-x; --max-transfer-size`
66 | specify the max transfer size used by a work queue. The value should be
67 | between 1 and the device maximum transfer size found in the
68 | max\_transfer\_size attribute under device. If the value is not a power
69 | of 2, it will be rounded up to the next power of 2.
70 | 
71 | COPYRIGHT
72 | =========
73 | 
74 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
75 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
76 | are free to change and redistribute it. There is NO WARRANTY, to the
77 | extent permitted by law.
78 | 


--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <head>
 3 | <meta content="text/html; charset=ISO-8859-1"
 4 | http-equiv="content-type">
 5 | <title></title>
 6 | </head>
 7 | <body>
 8 | <h1
 9 | style="border-bottom: 1px solid rgb(234, 236, 239); font-size: 2em; margin-top: 0px ! important; margin-right: 0px; margin-bottom: 16px; margin-left: 0px; font-weight: 600; line-height: 1.25; padding-bottom: 0.3em; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-style: normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">Intel®
10 | Data Accelerator Driver</h1>
11 | <p
12 | style="margin-top: 0px; margin-bottom: 16px; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
13 | The Intel® Data Accelerator Driver (IDXD) is a typical kernel
14 | driver that enumerates, configures and controls Intel® Data Stream Accelerator (DSA) device instances in a system.<br>
15 | This component is referred to in the Intel® Scalable IOV specification as the
16 | Virtual Device Composition Module (VDCM) that creates instances to
17 | facilitate exposing a virtual Intel® DSA instance to a guest OS.
18 | Download the source code for the idxd driver
19 | <a href="https://github.com/intel/idxd-driver">
20 | here</a>
21 | </p>
22 | <p
23 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
24 | accel-config is a utility that allows system administrators to
25 | configure groups,
26 | workqueues and engines. This parses the topology and
27 | capabilities exposed via sysfs and provides a command line interface to
28 | configure resources. <br>
29 | Download the source code for accel-config
30 | <a href="https://github.com/intel/idxd-config">
31 | here</a>
32 | </p>
33 | <p
34 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
35 | Documentation for accel-config can be accessed
36 | <a href="https://github.com/intel/idxd/blob/master/docs/index.md">
37 | here</a>
38 | </p>
39 | <p
40 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
41 | The scalable IOV specification can be accessed
42 | <a href="https://software.intel.com/en-us/download/intel-scalable-io-virtualization-technical-specification">
43 | here</a>
44 | </p>
45 | <p
46 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
47 | The Data Stream Accelerator(DSA) specification can be accessed
48 | <a href="https://software.intel.com/en-us/download/intel-data-streaming-accelerator-preliminary-architecture-specification">
49 | here</a>
50 | </p>
51 | </body>
52 | </html>
53 | 


--------------------------------------------------------------------------------
/docs/accel-config-list.md:
--------------------------------------------------------------------------------
  1 | 
  2 | NAME
  3 | ====
  4 | 
  5 | accel-config-list - display the platform accfg device(s) topology and
  6 | attributes in json format
  7 | 
  8 | SYNOPSIS
  9 | ========
 10 | 
 11 | >     accel-config list [<options>]
 12 | 
 13 | List all the DSA devices discovered by the driver and the driver
 14 | exported attributes.
 15 | 
 16 | Options can be specified to limit the output to devices of a certain
 17 | grouping where the grouping are devices, groups, work queues and
 18 | engines. By default, *accel-config list* with no options is equivalent
 19 | to:
 20 | 
 21 | >     accel-config list --devices --engines --groups --workqueues
 22 | 
 23 | EXAMPLE
 24 | =======
 25 | # accel-config list  
 26 |     [
 27 |     {
 28 |     "dev":"dsa0",
 29 |     "token_limit":0,
 30 |     "max_groups":4,
 31 |     "max_work_queues":8,
 32 |     "max_engines":4,
 33 |     "work_queue_size":64,
 34 |     "numa_node":-1,
 35 |     "op_cap":"0x1003f03ff",
 36 |     "state":"enabled",
 37 |     "max_tokens":64,
 38 |     "max_batch_size":512,
 39 |     "max_transfer_size":2147483648,
 40 |     "configurable":1,
 41 |     "pasid_enabled":1,
 42 |     "cdev_major":247,
 43 |     "clients":2,
 44 |     "groups":[
 45 |       {
 46 |         "dev":"group0.0",
 47 |         "tokens_reserved":0,
 48 |         "use_token_limit":0,
 49 |         "tokens_allowed":0,
 50 |         "traffic_class_a":-1,
 51 |         "traffic_class_b":-1,
 52 |         "grouped_workqueues":[
 53 |           {
 54 |             "dev":"wq0.0",
 55 |             "mode":"shared",
 56 |             "size":16,
 57 |             "group_id":0,
 58 |             "priority":10,
 59 |             "block_on_fault":1,
 60 |             "cdev_minor":0,
 61 |             "type":"user",
 62 |             "name":"app1",
 63 |             "threshold":15,
 64 |             "state":"enabled",
 65 |             "clients":1
 66 |           }
 67 |         ],
 68 |         "grouped_engines":[
 69 |           {
 70 |             "dev":"engine0.0",
 71 |             "group_id":0
 72 |           },
 73 |           {
 74 |             "dev":"engine0.1",
 75 |             "group_id":0
 76 |           }
 77 |         ]
 78 |       },
 79 |       {
 80 |         "dev":"group0.1",
 81 |         "tokens_reserved":0,
 82 |         "use_token_limit":0,
 83 |         "tokens_allowed":0,
 84 |         "traffic_class_a":-1,
 85 |         "traffic_class_b":-1,
 86 |         "grouped_workqueues":[
 87 |           {
 88 |             "dev":"wq0.1",
 89 |             "mode":"dedicated",
 90 |             "size":16,
 91 |             "group_id":1,
 92 |             "priority":10,
 93 |             "block_on_fault":1,
 94 |             "cdev_minor":1,
 95 |             "type":"user",
 96 |             "name":"app2",
 97 |             "threshold":0,
 98 |             "state":"enabled",
 99 |             "clients":1
100 |           }
101 |         ],
102 |         "grouped_engines":[
103 |           {
104 |             "dev":"engine0.2",
105 |             "group_id":1
106 |           },
107 |           {
108 |             "dev":"engine0.3",
109 |             "group_id":1
110 |           }
111 |         ]
112 |       },
113 |       {
114 |         "dev":"group0.2",
115 |         "tokens_reserved":0,
116 |         "use_token_limit":0,
117 |         "tokens_allowed":0,
118 |         "traffic_class_a":-1,
119 |         "traffic_class_b":-1
120 |       },
121 |       {
122 |         "dev":"group0.3",
123 |         "tokens_reserved":0,
124 |         "use_token_limit":0,
125 |         "tokens_allowed":0,
126 |         "traffic_class_a":-1,
127 |         "traffic_class_b":-1
128 |       }
129 |     ]
130 | 
131 | 
132 | OPTIONS
133 | =======
134 | 
135 | `-d; --device=`  
136 | A accfg device name like dsa{number}. Filter listing by devices that
137 | reference the given device.
138 | 
139 | `-g; --group=`  
140 | An *groupX.Y* group name, or device id plus group id tuple *X.Y*. Limit
141 | the group list to the single identified device if present.
142 | 
143 | `-q; --workqueue=`  
144 | An *wqX.Y* workqueue name, or device id plus workqueue id tuple *X.Y*.
145 | Limit the workqueue list to the single identified device if present.
146 | 
147 | `-e; --engine=`  
148 | An *engineX.Y* engine name, or device id plus engine id tuple *X.Y*.
149 | Limit the engine list to the single identified device if present.
150 | 
151 | `-D; --devices`  
152 | Include device info in the listing
153 | 
154 | `-G; --regions`  
155 | Include group info in the listing
156 | 
157 | `-Q; --workqueues`  
158 | Include active workqueue info in the listing
159 | 
160 | `-E; --engines`  
161 | Include both idle (not enabled) and active engine info in the listing
162 | 
163 | TO BE CHANGED -i:: --idle:: Include idle (not enabled) devices in the
164 | listing
165 | 
166 | COPYRIGHT
167 | =========
168 | 
169 | Copyright (c) 2016 - 2019, Intel Corporation. License GPLv2: GNU GPL
170 | version 2 <http://gnu.org/licenses/gpl.html>. This is free software: you
171 | are free to change and redistribute it. There is NO WARRANTY, to the
172 | extent permitted by law.
173 | 


--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
 1 | <html>
 2 | <head>
 3 | <meta content="text/html; charset=ISO-8859-1"
 4 | http-equiv="content-type">
 5 | <title></title>
 6 | </head>
 7 | <body>
 8 | <h1
 9 | style="border-bottom: 1px solid rgb(234, 236, 239); font-size: 2em; margin-top: 0px ! important; margin-right: 0px; margin-bottom: 16px; margin-left: 0px; font-weight: 600; line-height: 1.25; padding-bottom: 0.3em; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-style: normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">Intel®
10 | Data Accelerator Driver</h1>
11 | <p
12 | style="margin-top: 0px; margin-bottom: 16px; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
13 | The Intel® Data Accelerator Driver (IDXD) is a typical kernel
14 | driver that enumerates, configures and controls Intel® Data Streaming Accelerator (DSA) device instances in a system.<br>
15 | This component is referred to in the Intel® Scalable IOV specification as the
16 | Virtual Device Composition Module (VDCM) that creates instances to
17 | facilitate exposing a virtual Intel® DSA instance to a guest OS.
18 | Download the source code for the idxd driver
19 | <a href="https://github.com/intel/idxd-driver">
20 | here</a>
21 | </p>
22 | <p
23 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
24 | accel-config is a utility that allows system administrators to
25 | configure groups,
26 | workqueues and engines. This parses the topology and
27 | capabilities exposed via sysfs and provides a command line interface to
28 | configure resources. <br>
29 | Download the source code for accel-config
30 | <a href="https://github.com/intel/idxd-config">
31 | here</a>
32 | </p>
33 | <p
34 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
35 | Documentation for accel-config can be accessed
36 | <a href="https://github.com/intel/idxd/blob/master/docs/index.md">
37 | here</a>
38 | </p>
39 | <p
40 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
41 | email list for accel-config can be reached at
42 | <a href="mailto:accel-config@lists.01.org">
43 | here</a>
44 | </p>
45 | <p
46 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
47 | The scalable IOV specification can be accessed
48 | <a href="https://software.intel.com/en-us/download/intel-scalable-io-virtualization-technical-specification">
49 | here</a>
50 | </p>
51 | <p
52 | style="margin-top: 0px; margin-bottom: 16px ! important; color: rgb(36, 41, 46); font-family: -apple-system,BlinkMacSystemFont,&quot;Segoe UI&quot;,Helvetica,Arial,sans-serif,&quot;Apple Color Emoji&quot;,&quot;Segoe UI Emoji&quot;; font-size: 16px; font-style: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; background-color: rgb(255, 255, 255);">
53 | The Data Streaming Accelerator(DSA) specification can be accessed
54 | <a href="https://software.intel.com/en-us/download/intel-data-streaming-accelerator-preliminary-architecture-specification">
55 | here</a>
56 | </p>
57 | </body>
58 | </html>
59 | 


--------------------------------------------------------------------------------