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 2358543A40; Wed, 7 Feb 2024 11:30:33 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A385040279; Wed, 7 Feb 2024 11:30:32 +0100 (CET) Received: from mail-qt1-f171.google.com (mail-qt1-f171.google.com [209.85.160.171]) by mails.dpdk.org (Postfix) with ESMTP id AE3414021D for ; Wed, 7 Feb 2024 11:30:31 +0100 (CET) Received: by mail-qt1-f171.google.com with SMTP id d75a77b69052e-42a8900bb93so3219201cf.1 for ; Wed, 07 Feb 2024 02:30:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1707301831; x=1707906631; darn=dpdk.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=czkjde7Yxsbrjaji7Sw3MO9M/fxtXF3YHLqhNhka2xY=; b=fNcRPyGBwnFUB2cyTPjoeYW1nT47hDYkDnr4EPM2FccskVz+rWpgLrabtGfXYX0AXL oce7ev8AsLZQ0tFBojTQ5JxzQXaDYoh6sHzEu824VVmAlDjnzh+e+aIKxZHLw3y9r6KX nYNDFFt+fBHWAkQ9FvioFXBdbyTsev8IqxB0ANvgQ4v3Gz72Y3armu8DlEbeo6Lark7r 0ID/aEtSKphD/W3Dvz+FDxEVnFXDOTlaCmLEj+Vcm16FIjmtw4M9sWafjgHhum+lUVyi WlJRtHHJNNdjs7q9PKoSgiJBB4EIrse0drXf1w1ckY4A6D08mdtLIhHiH08fUBNy/zBV gRmg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1707301831; x=1707906631; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=czkjde7Yxsbrjaji7Sw3MO9M/fxtXF3YHLqhNhka2xY=; b=I6kkRijAdFsM/7B0hNPZx0Bp6/0dkOUCtfnONnKKmimB0p5Bi49dn/EQeLc4UZiJtq ZUnE5Sq/+nf8COscqLrxILQw6amJeeJVyeqgsmfKodRta0tbwNF2ZQ/wIbHB5qIlESDB tPP8xUbcxourWWULgRmaHdinEZMJCnk4p3dm+0Hnd/EHvzawHrSyeNpWRMFn6Vvj3wjU /BeMcVXtdZYCpoZ4Qh68vUNbts/+6mru5MepxXtLqlaU99N7EJMvI8qQPEl7NnmNfFbe x1hl/4COx4+egAoFW9yF3ZDGJnfaJdAJ9nZG39V0s4kYoQvy3h+9EY+pliG1BxlcKD3j qbIA== X-Gm-Message-State: AOJu0YxX7Q+ch22IyG8RxFy9IJASbDucjndP9RuxCsrNEzaMQncUfd26 F0InqEtjsPgH/ez4khmqsVQ2wOf04zINqzpKnC00xWBJJMUP7pO/T5/LpwmE20mzoqFQ3719ebs kHRpkFb9RRy+LuvJExWF7hXSrZPA= X-Google-Smtp-Source: AGHT+IEkIoKuw2Shcs5gx0pChkEca8d2wlkLYtYY1doG/Q+HQIkpOFBVwv5h1feIy60EkTm89ZOYBCwZ1vamNNzYA4E= X-Received: by 2002:ac8:4812:0:b0:42a:b0b6:73ee with SMTP id g18-20020ac84812000000b0042ab0b673eemr4584984qtq.19.1707301830971; Wed, 07 Feb 2024 02:30:30 -0800 (PST) MIME-Version: 1.0 References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240202123953.77166-1-bruce.richardson@intel.com> <20240202123953.77166-4-bruce.richardson@intel.com> In-Reply-To: <20240202123953.77166-4-bruce.richardson@intel.com> From: Jerin Jacob Date: Wed, 7 Feb 2024 16:00:04 +0530 Message-ID: Subject: Re: [PATCH v3 03/11] eventdev: update documentation on device capability flags To: Bruce Richardson Cc: dev@dpdk.org, jerinj@marvell.com, mattias.ronnblom@ericsson.com, abdullah.sevincer@intel.com, sachin.saxena@oss.nxp.com, hemant.agrawal@nxp.com, pbhagavatula@marvell.com, pravin.pathak@intel.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 Sat, Feb 3, 2024 at 12:59=E2=80=AFPM 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 > --- > V3: Updated following feedback from Mattias > --- > lib/eventdev/rte_eventdev.h | 130 +++++++++++++++++++++++++----------- > 1 file changed, 92 insertions(+), 38 deletions(-) > */ > #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2) > /**< Event device operates in distributed scheduling mode. > + * > * In distributed scheduling mode, event scheduling happens in HW or > - * rte_event_dequeue_burst() or the combination of these two. > + * rte_event_dequeue_burst() / rte_event_enqueue_burst() or the combinat= ion of these two. > * If the flag is not set then eventdev is centralized and thus needs a > * dedicated service core that acts as a scheduling thread . Please remove space between thread and . in the existing code. > * > - * @see rte_event_dequeue_burst() > + * @see rte_event_dev_service_id_get Could you add () around all the functions so that looks good across the ser= ies? > */ > #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3) > /**< Event device is capable of enqueuing events of any type to any queu= e. > - * If this capability is not set, the queue only supports events of the > - * *RTE_SCHED_TYPE_* type that it was created with. > * > - * @see RTE_SCHED_TYPE_* values > + * If this capability is not set, each queue only supports events of the > + * *RTE_SCHED_TYPE_* type that it was created with. > + * The behaviour when events of other scheduling types are sent to the q= ueue is > + * currently undefined. I think, in header file, we can remove "currently" p > */ > > #define RTE_EVENT_DEV_CAP_PROFILE_LINK (1ULL << 12) > -/**< Event device is capable of supporting multiple link profiles per ev= ent port > - * i.e., the value of `rte_event_dev_info::max_profiles_per_port` is gre= ater > - * than one. > +/**< Event device is capable of supporting multiple link profiles per ev= ent port. > + * > + * The above line can be removed. > + * 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 a= t 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 se= t). > + * > + * @see rte_event_port_profile_links_set rte_event_port_profile_links_ge= t > + * @see rte_event_port_profile_switch > + * @see RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK > */ >