Return-Path: Received: from smtp2.osuosl.org (smtp2.osuosl.org [IPv6:2605:bc80:3010::133]) by lists.linuxfoundation.org (Postfix) with ESMTP id 25082C0032 for ; Tue, 1 Aug 2023 21:59:32 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id F3D144031F for ; Tue, 1 Aug 2023 21:59:31 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org F3D144031F Authentication-Results: smtp2.osuosl.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=nAkHScF8 X-Virus-Scanned: amavisd-new at osuosl.org X-Spam-Flag: NO X-Spam-Score: -3.606 X-Spam-Level: X-Spam-Status: No, score=-3.606 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id RO-UzTuzvQFs for ; Tue, 1 Aug 2023 21:59:31 +0000 (UTC) Received: from mgamail.intel.com (unknown [192.55.52.88]) by smtp2.osuosl.org (Postfix) with ESMTPS id 4F04840522 for ; Tue, 1 Aug 2023 21:59:31 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 4F04840522 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1690927171; x=1722463171; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=hEdJJgiIWcwwukxTgAWJap5VmFmWpZ4ACLyD4QJb7Sc=; b=nAkHScF8uy4uT1WgYfhv80wzqckWQJxzMaBAnUs6QDmJUTQ4IQM+YyiR VNFBZyNiPsxqL7G1FNkVaR7z4B4w8+U9pH/eb2/D47hx1V2h7ETlq2nXJ 0dFBfMx58oRvH8dGJbgC2kfrtnp2/Wlpw750MohlrzNcf5zPHJMdEflgy 7DKFc4IyatThSNjGzElzPrjRgNU3pIJelq9FLWPfUJgBpir10ItNmYlCT vz+52bCnA5Oc3PfkkKmNfWHcgYeY8s5TB8BO0rn1muSzDsDFAOLzJvbdC 9glxwrZiz+suXkPcvTcuK8FQtdQj1VqoNykf6g3UpVQ4p/EQt9W5m6ini A==; X-IronPort-AV: E=McAfee;i="6600,9927,10789"; a="400365412" X-IronPort-AV: E=Sophos;i="6.01,248,1684825200"; d="scan'208";a="400365412" Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Aug 2023 14:52:22 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10789"; a="763974449" X-IronPort-AV: E=Sophos;i="6.01,248,1684825200"; d="scan'208";a="763974449" Received: from fyu1.sc.intel.com ([172.25.103.126]) by orsmga001.jf.intel.com with ESMTP; 01 Aug 2023 14:52:21 -0700 From: Fenghua Yu To: accel-config@lists.linuxfoundation.org, "Ramesh Thomas" , "Tony Luck" Date: Tue, 1 Aug 2023 14:52:32 -0700 Message-Id: <20230801215232.4001749-8-fenghua.yu@intel.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20230801215232.4001749-1-fenghua.yu@intel.com> References: <20230801215232.4001749-1-fenghua.yu@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [Accel-config] [PATCH 7/7] accel-config: Add doumentation for new command "config-user-default" X-BeenThere: accel-config@lists.linuxfoundation.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: accel-config List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 01 Aug 2023 21:59:32 -0000 The new command "config-user-default" and its options are documented. Signed-off-by: Fenghua Yu Reviewed-by: Ramesh Thomas --- Documentation/accfg/Makefile.am | 6 +- .../accel-config-config-user-default.txt | 75 +++++++++++++++++++ 2 files changed, 79 insertions(+), 2 deletions(-) create mode 100644 Documentation/accfg/accel-config-config-user-default.txt diff --git a/Documentation/accfg/Makefile.am b/Documentation/accfg/Makefile.am index 2e938ed..ed2b288 100644 --- a/Documentation/accfg/Makefile.am +++ b/Documentation/accfg/Makefile.am @@ -29,7 +29,8 @@ man1_MANS = \ accel-config-disable-device.1 \ accel-config-disable-wq.1 \ accel-config-enable-wq.1 \ - accel-config-enable-device.1 + accel-config-enable-device.1 \ + accel-config-config-user-default.1 EXTRA_DIST = \ $(man1_MANS) \ @@ -44,7 +45,8 @@ EXTRA_DIST = \ accel-config-disable-device.txt \ accel-config-disable-wq.txt \ accel-config-enable-wq.txt \ - accel-config-enable-device.txt + accel-config-enable-device.txt \ + accel-config-config-user-default.txt CLEANFILES = $(man1_MANS) diff --git a/Documentation/accfg/accel-config-config-user-default.txt b/Documentation/accfg/accel-config-config-user-default.txt new file mode 100644 index 0000000..612e414 --- /dev/null +++ b/Documentation/accfg/accel-config-config-user-default.txt @@ -0,0 +1,75 @@ +// SPDX-License-Identifier: GPL-2.0 + +accel-config-config-user-default(1) +=================================== + +NAME +---- +accel-config-config-user-default - load a pre-defined user default configuration + +SYNOPSIS +-------- +[verse] +'accel-config config-user-default' [] + +Without an option, config-user-default loads a pre-defined user default +configuration. + +There is a config file template at contrib/configs/user_default_profile.conf. +Run "accel-config config-user-default -c user_default_profile.conf" to +configure all available devices with the template values. Any modifications to +the template file should retain the json format. + +EXAMPLE +------- +# accel-config config-user-default + +The command will load the pre-defined user default config to all available +WQs and engines on all available DSA and IAX devices with the following +attributes: + All WQs and all engines are in group 0 + + WQ attributes: + priority: 1 + group_id: 0 + block_on_fault: 1 + ats_disable: 0 + prs_disable: 1 + mode: "shared" + type: "user" + name: "user_default_wq" + driver_name: "user" + size: max WQ size / max WQs + threshold: size + max_transfer_size: default value + max_batch_size: default value on DSA. N/A on IAX + op_config: default value + + Attributes of all devices and groups are default values. + +# accel-config config-user-default -c /etc/accel-config/contrib/configs/user_default_profile.conf + +The command will load the specified user default config file. The config +file is a template that specifies attributes and devices. User can edit +the config file per requirements. + +# accel-config config-user-default -d -n +The command will disable all WQs named (default name is +"user_default_wq"). + +OPTIONS +------- +-c:: +--config-file:: + to specify the location of the customized user default config file + +-n:: +--name:: + to specify WQ name which will be used to disable enabled WQs +-d:: +--disable:: + to disable the configured devices and wqs + +-v:: +--verbose:: + verbose -- 2.31.1