From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C6B8B43A1E; Wed, 31 Jan 2024 15:09:16 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3BF2A40275; Wed, 31 Jan 2024 15:09:16 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.11]) by mails.dpdk.org (Postfix) with ESMTP id 895FD4026C for ; Wed, 31 Jan 2024 15:09:14 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706710155; x=1738246155; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=cZ5pz/RVQQnijwtI320MZ6A/eZ7uS1RUbQau3g4Wz54=; b=YGLY4ZD8WGBGYSa1XhGKhILiud5+ukGPhFrwZhfOGBwDuXevl8V7YQeN +wzB0veg7mqw+/tgetBqD0GPtSp1N3AUcrPvguyZ2Y42pArvhvgt6DUQ5 tkhrHUao2PK9Ce1vkYFXec2TaoEw6wW47GB10otefFAwPVyOZak4/nuoc fzos24I5GGSIm7FMPpl7eP3oSr/hKyizBYpK/FIFOyrsjHcPW8bheCAKl kzOSeD7dASNA15RRX6zn2XaNCjiPjQ8DQSNANiwL+hzfVJGCdriJiimBz PKKqh0H3DuQ4Dya+W1MNcXKUzJbZovf1oWeyXb6HsazPfB8ZwMQNEw9tS A==; X-IronPort-AV: E=McAfee;i="6600,9927,10969"; a="10270960" X-IronPort-AV: E=Sophos;i="6.05,231,1701158400"; d="scan'208";a="10270960" Received: from orviesa001.jf.intel.com ([10.64.159.141]) by fmvoesa105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Jan 2024 06:09:13 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.05,231,1701158400"; d="scan'208";a="36877764" Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by orviesa001.jf.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 31 Jan 2024 06:09:12 -0800 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx602.amr.corp.intel.com (10.18.126.82) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Wed, 31 Jan 2024 06:09:11 -0800 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Wed, 31 Jan 2024 06:09:10 -0800 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35 via Frontend Transport; Wed, 31 Jan 2024 06:09:10 -0800 Received: from NAM11-BN8-obe.outbound.protection.outlook.com (104.47.58.168) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.35; Wed, 31 Jan 2024 06:09:10 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HLQWWyb1qFZTM1x53SjKP1w+l7uW20l9ZIeFkNWof1oAagicXohgeWpX+t64WPtl9P8IaSu360AvctuWP6AmVI2fSnpHiVMH4v/zPR5TDGbBmtOl1dfOeai7KVFSQmYDruOCqH6Psefmhazkj4oAH8F1XAYOk17lUlPTr184+V9Zg6uZ2AgfvDZyPPZ558AnaZhfX/A7z4EmrgLF5Lr+ZZSweLWmgnEwZen94HfzxeZ1SvVBLrjtpPQy4IuDh9OIlAua2MqYGHEH8ZkQ0wDqOo5X2wqVvwrKAEbAV8uBnSbqVO7aeWHy70iJ8bgY8ADJ7gZOb3f6WpJ4Vu5rouLPmw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=duAP1hRUXgYe9mWWKp165b+nwJhEi2CD5fPay4yAboU=; b=JMQi5Ign/ctiVmdknPeWF64RnCKaXgeVG4tygi8PV23WiDQgAy9s48qK6FBbH8pBHmdwKMjcWylydA8llU4Y8qy70rk2kzQIg8pFRYCKkGm7/ofMrcMAkJOKTAMy6V6MnTKKDkQSwjAaOCc03I06OuJh1mAf9JRkZP0VarCsct7dZWXvd0xvXRDU8UDMOjTlWuV8BOtuscT/GmKGNSZU3bquyO03X0aDHQnkl5lYkNhDU1CtQg7xtobpcHJIAqpftSkC6afGxFXAY2FtsPjhor9NcrdmnMLEWAuRQpaMbg+oKwh/vwqUsvZWJYC/K56az/9Od1W/TEwZhtjgnvDalg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by BL1PR11MB5384.namprd11.prod.outlook.com (2603:10b6:208:311::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7249.24; Wed, 31 Jan 2024 14:09:08 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c%5]) with mapi id 15.20.7249.017; Wed, 31 Jan 2024 14:09:08 +0000 Date: Wed, 31 Jan 2024 14:09:02 +0000 From: Bruce Richardson To: Mattias =?iso-8859-1?Q?R=F6nnblom?= CC: , , , , , , , Subject: Re: [PATCH v2 03/11] eventdev: update documentation on device capability flags Message-ID: References: <20240118134557.73172-1-bruce.richardson@intel.com> <20240119174346.108905-1-bruce.richardson@intel.com> <20240119174346.108905-4-bruce.richardson@intel.com> <93bed273-2ea3-48fe-adaa-0a546ab03730@lysator.liu.se> Content-Type: text/plain; charset="iso-8859-1" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <93bed273-2ea3-48fe-adaa-0a546ab03730@lysator.liu.se> X-ClientProxiedBy: DB9PR06CA0022.eurprd06.prod.outlook.com (2603:10a6:10:1db::27) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|BL1PR11MB5384:EE_ X-MS-Office365-Filtering-Correlation-Id: 07e46a48-ce0c-4071-0401-08dc226630ae X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: +sAAXHrYajCnU9JZG/g8drbGmJnbzy0iZHTh+EVFHXAeKWLf9eKGBQvcbYBcsMqJ6ePg9McviSWPtK6HK6ZvogsUsO2lDG5UOpX1JdqPoLYPehLHRBHA3vUVqg5hZYCGuwEgOoEqTKncYwFTQ6cwwKy9q9WNmG7lQO8nb7V3WEFysrka48QHJq5FTCVxtJZFP4cAbHf9ymZJZSReUkVcliyAd2pJDIURyyYjEZx7bM3b637RwjerlaiF0c1VSo5/rAbnGIJ986dlPTyIUzSEHYtc9/XAlkBQiWWm+Ijszne8vcszNb2ZLWD/vaFBqdilH2g0JBWYOWjn2DmfYFAGLFwgdKvWXy856aE1YeFkT8gt5BF80jVJEtiVM5/eQu007jkOhvK1w24G0/56VV8yFI/UezP3k7sBeCU673ub+BO8bLHNI3azWX1WcAJPPX/a3JIFLyFC0yjiywK/hNgMuC4tWNefx8s7ButzvzJiYtmtDvUDaxTCOGUPWEr6X5imx5sll6mwiifERMyGrCXAj1GQuxLchQ0iMIRtXSj8xJvGpdzXke5nukMsY4JLWmDi X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(136003)(376002)(366004)(396003)(39860400002)(346002)(230922051799003)(186009)(64100799003)(1800799012)(451199024)(6666004)(66574015)(86362001)(6916009)(316002)(66946007)(66476007)(66556008)(38100700002)(44832011)(82960400001)(8936002)(8676002)(4326008)(478600001)(6512007)(107886003)(26005)(6506007)(53546011)(5660300002)(6486002)(83380400001)(296002)(15650500001)(2906002)(41300700001); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?iso-8859-1?Q?Eimaq93sRlyusNqr9Hs6p5YVrBuzC5RU9viW8dGigBmAYUCaJWjxrSJngx?= =?iso-8859-1?Q?BiKIoqY7zd+qujlw94wIj+RdoV6KSogL3aqR/MNXnw2ORvTh1Kve/g74Vn?= =?iso-8859-1?Q?H1L/JM8A/QTGe1JR8drFKi1BfhqQVU1E+JbUuWpiZWTUQKllzt2IGIC2CG?= =?iso-8859-1?Q?IsUJrci6xjfjU20GI0QmUps1rnzltg60y61Vxd3fsKKlb+zrE8nOMtNEAw?= =?iso-8859-1?Q?TUcVHXO3bfkpdEU7Hl/ZAmaEfYSKK6vp8rsQqVYuGnzzTf2TIG5M88VQ/z?= =?iso-8859-1?Q?kTGEk7cYhRTjfy0S00D1tl5jhi1kIbL4rcbWg9bRo00KZ9ivdlrjkbRInY?= =?iso-8859-1?Q?Veu3rEXn+lUufY0s9hH6ha9YausGcz4XEMFIzxAf6Uzv5dufyqJuOtCQAE?= =?iso-8859-1?Q?fQWPpZyz63YuFvmAATRQVvUT9fgMXRiDHntwBWJBxLDTrHgxFLwUE8IXpu?= =?iso-8859-1?Q?fb5wg7Tp1qvelyUJeBmox/yyu1oh/12YqjdGBJhORA7bbjs//S5yqx3OgE?= =?iso-8859-1?Q?ZeELDJxKPCxPCHVNr/7ZkFxh7YzqdMLWLe0oHOC/tT6q5mMeBhAQMAnGgR?= =?iso-8859-1?Q?bDq6HZJuXa3Y9Cy01Phw/ApcfbTdzw/slS9IQiD+zDK/Lrhx163/iQT4SD?= =?iso-8859-1?Q?WNmUK0uJiHuCv5khTyGEDUBDX+RpDUbuX97CQBFEWDkVha6yP9Dwus9tcL?= =?iso-8859-1?Q?EMhIKzQVlXV+lOdpK6RqX0nQHdDtmZevO9NClUPYUlchYukPHWtHwl6dRs?= =?iso-8859-1?Q?QG3Lf5yg24eQMg0VMd+cQdZ/XUS2w01rAgbP67otFUxQGPUJj9xhOtFL+x?= =?iso-8859-1?Q?wpTAabcgD9vr6r6mV2ljVjvKEntloO9TvXGCzfbGeYuRATPMNqtYzrqBO4?= =?iso-8859-1?Q?zWEc8tftjq36hWzxmVSDa8S9J2cDT264BGjJcWzWXVXA18bDZM4qlQu/EP?= =?iso-8859-1?Q?skMoz9o/q/i3cBKm+GBNocD+k9Bm9gv0HaFNDy+BNof4P+NUCZq3q2QKfZ?= =?iso-8859-1?Q?SI3heGZWBOkBtld88pGX8D8gCwrL3InmBvxOSXgPw7dbO6RqTt9s2vqKd9?= =?iso-8859-1?Q?Ap7v6YxGy83cOYYnB3n+o/1MfBIbJCkE6mGalxwmiRRguQRsLrE/2/90k0?= =?iso-8859-1?Q?p9Rtla0p8QVzSEtTaL3zUkyvEHQ8OLgQoLStcN/Jy0ycio8UfPew2eVZPn?= =?iso-8859-1?Q?TKfLSU7InHtMjiBpDAqNOURRW+0Jkj8DdKn/zHLE8aCkPkiij+JS7cUZPe?= =?iso-8859-1?Q?2hmIkIzefOS+c5JMBDFGEyqpN1AY1wQr5BrJ1hEby8Di+oJI3s1JHTxZqB?= =?iso-8859-1?Q?TUaXmA/eVqOOTYRQbO4frD5PI5407KZ4oQqXZRcriUC1aW/3W5C4R0lWZ5?= =?iso-8859-1?Q?U4dD2oEa+2GLyk6Xumg7X9cax+5LH9YZrMPRbdoOAAzx2AJTra6BVnFI7s?= =?iso-8859-1?Q?CrpH0Jnm58pSPATvVqV5yzI0hdEo+VtieSbZI0r5vsNd2EKF6Mv8MriygQ?= =?iso-8859-1?Q?AZkBAHGd7F8WClyrtnlMJ4p7ioeXfkes4u1ZaH7jAJuFDhU6SoFUtVnElS?= =?iso-8859-1?Q?P4OkxaJGQov4qod1fs34p+DRrx8Xlrr7TgdHC1PF/AwEwXOuBuS/g4/M8G?= =?iso-8859-1?Q?JQLOvQJcXR/1aRO7zBPhZqbLV+0o1EMn2WwpOQjueRVCUtX1/+feJYrA?= =?iso-8859-1?Q?=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: 07e46a48-ce0c-4071-0401-08dc226630ae X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Jan 2024 14:09:08.1024 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: zjJc7hk5UguSo8RzngHeyfIzI4dlwoUer42XxjFrTEPGBNh+bb53caFvaN25NNcPSp785P1JvHeuTbJCMqgslvv3Sk69zmQSk9VefzRpwD8= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL1PR11MB5384 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Tue, Jan 23, 2024 at 10:18:53AM +0100, Mattias Rönnblom wrote: > On 2024-01-19 18:43, Bruce Richardson wrote: > > Update the device capability docs, to: > > > > * include more cross-references > > * split longer text into paragraphs, in most cases with each flag having > > a single-line summary at the start of the doc block > > * general comment rewording and clarification as appropriate > > > > Signed-off-by: Bruce Richardson > > --- > > lib/eventdev/rte_eventdev.h | 130 ++++++++++++++++++++++++++---------- > > 1 file changed, 93 insertions(+), 37 deletions(-) > > > > * If this capability is not set, the queue only supports events of the > > - * *RTE_SCHED_TYPE_* type that it was created with. > > + * *RTE_SCHED_TYPE_* type that it was created with. > > + * Any events of other types scheduled to the queue will handled in an > > + * implementation-dependent manner. They may be dropped by the > > + * event device, or enqueued with the scheduling type adjusted to the > > + * correct/supported value. > > Having the application setting sched_type when it was already set on a the > level of the queue never made sense to me. > > I can't see any reasons why this field shouldn't be ignored by the event > device on non-RTE_EVENT_QUEUE_CFG_ALL_TYPES queues. > > If the behavior is indeed undefined, I think it's better to just say > "undefined" rather than the above speculation. > Updating in v3 to just say it's undefined. > > * > > - * @see RTE_SCHED_TYPE_* values > > #define RTE_EVENT_DEV_CAP_RUNTIME_QUEUE_ATTR (1ULL << 11) > > /**< Event device is capable of changing the queue attributes at runtime i.e > > - * after rte_event_queue_setup() or rte_event_start() call sequence. If this > > - * flag is not set, eventdev queue attributes can only be configured during > > + * after rte_event_queue_setup() or rte_event_dev_start() call sequence. > > + * > > + * If this flag is not set, eventdev queue attributes can only be configured during > > * rte_event_queue_setup(). > > "event queue" or just "queue". > Ack. > > + * > > + * @see rte_event_queue_setup > > */ > > #define RTE_EVENT_DEV_CAP_PROFILE_LINK (1ULL << 12) > > -/**< Event device is capable of supporting multiple link profiles per event port > > - * i.e., the value of `rte_event_dev_info::max_profiles_per_port` is greater > > - * than one. > > +/**< Event device is capable of supporting multiple link profiles per event port. > > + * > > + * > > + * When set, the value of `rte_event_dev_info::max_profiles_per_port` is greater > > + * than one, and multiple profiles may be configured and then switched at runtime. > > + * If not set, only a single profile may be configured, which may itself be > > + * runtime adjustable (if @ref RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK is set). > > + * > > + * @see rte_event_port_profile_links_set rte_event_port_profile_links_get > > + * @see rte_event_port_profile_switch > > + * @see RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK > > */ > > /* Event device priority levels */ > > #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0 > > -/**< Highest priority expressed across eventdev subsystem > > +/**< Highest priority expressed across eventdev subsystem. > > "The highest priority an event device may support." > or > "The highest priority any event device may support." > > Maybe this is a further improvement, beyond punctuation? "across eventdev > subsystem" sounds awkward. > Still not very clear. Talking about device support implies that its possible some devices may not support it. How about: "highest priority level for events and queues".