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 824034339F; Thu, 23 Nov 2023 02:27:40 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C15EC42EE8; Thu, 23 Nov 2023 02:27:12 +0100 (CET) Received: from mail-oo1-f43.google.com (mail-oo1-f43.google.com [209.85.161.43]) by mails.dpdk.org (Postfix) with ESMTP id 21F1040041 for ; Thu, 23 Nov 2023 02:27:03 +0100 (CET) Received: by mail-oo1-f43.google.com with SMTP id 006d021491bc7-582050ce2d8so61350eaf.0 for ; Wed, 22 Nov 2023 17:27:03 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1700702821; x=1701307621; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=NaKMXlXg4ykFm0kZKeVKbTFWUHXM5RVAaPiA6swpqbw=; b=Bda+BJdbMnY2c28zEhkSGN+zGBfJ9LanPdh9cB1VEYRySdk71SKNoyQrJewjdHPOMN lJsGL5Z9/wkheujBIy8D6zYthcR8ruvMLPfPnyUGhYUyiSJUROOQuZmSW8MNR9OzERwQ zZwXRwa5JtAWQ68bETuDI1L3OicTW7a9lP8APIMByK5I51TOpWuCjwUBmpPbESbnE91M zg2GpC+AMAGoLsHQ+eqeSDduXx60By1Ado4pvoHTP1xo9y2ZsXYhpVTzzhn+Ta2Q+id6 jaAUa6qLXS4jcWdo8NHKzewyzNUH7gy0UpzgxcPR2WLy6SKpGjABJuSy5QVSj0TBWUlY /fag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700702821; x=1701307621; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=NaKMXlXg4ykFm0kZKeVKbTFWUHXM5RVAaPiA6swpqbw=; b=LBGj03gGBbEK3aVzf7yV+8f6BjGQmDFXZmXyw/nzmAufue3NTAKzAiqW9rpFUhtVAW j6rqrNsRVw12ynUPZfdWaoTlMazHIbGv/pC0axINqsvQY/MosZqA281uKMnlEDQcy6+v HhT/kp58exIopBmM1W8d1B+0D42p2fseio+lOYosoMyImxwyXJ4t8nvm2LxgNl+mTsOi tOiwuID9kGo2ZGhJxpyzTkkIBNdnqCYBmX1Kr6gRD31zRegiY5XqqlS/puwrTbY0hLWy eQrlnVvG+V/IOcJnNQib48/qF6yIFk0kThHyMM65hZwbX+lk/wAPC9GKnuKvJzWFUZr/ mZZw== X-Gm-Message-State: AOJu0Yyl/13mspryRB0s9CZ01QoSuYEIinAU4bhiZz+1kC/nb7GS00Lr 5A1/7yjH5VABjnRoOYhSLAwcloU/iSFoRdXqyEo= X-Google-Smtp-Source: AGHT+IFvQ9qmezoy6v/Qu/UtMztFFftp9KIcdUdKrGvJpPaM0FYzcNsLC4nezK6BJHMwRHMXQ0txWA== X-Received: by 2002:a05:6358:71d:b0:16d:abd9:f29e with SMTP id e29-20020a056358071d00b0016dabd9f29emr4253862rwj.2.1700702821594; Wed, 22 Nov 2023 17:27:01 -0800 (PST) Received: from localhost.localdomain ([2600:1700:20c0:a560:40f7:d2c:d53a:d071]) by smtp.gmail.com with ESMTPSA id j184-20020a0dc7c1000000b005a815346d95sm89832ywd.71.2023.11.22.17.27.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Nov 2023 17:27:01 -0800 (PST) From: David Young To: dev@dpdk.org Cc: Bruce Richardson , Aaron Conole , David Young Subject: [PATCH v4 6/6] Section 6: Glossary Date: Wed, 22 Nov 2023 20:26:27 -0500 Message-ID: <20231123012633.2005-7-dave@youngcopy.com> X-Mailer: git-send-email 2.41.0.windows.1 In-Reply-To: <20231123012633.2005-1-dave@youngcopy.com> References: <20231103040202.2849-1-dave@youngcopy.com> <20231123012633.2005-1-dave@youngcopy.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 -Glossary Introduction Formatting: Refined the introduction's formatting for clarity. -Directive Implementation: Used .. glossary:: directive for structured term definitions. -Term Definitions and Linking: Expanded definitions for terms like BIOS, Bifurcated Driver, Clang-LLVM, etc., with reference tags and links to their respective content pages. Enhanced Navigation: Integrated hyperlinks for each term, directing to detailed information on content pages. --- doc/guides/getting_started_guide/glossary.rst | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 doc/guides/getting_started_guide/glossary.rst diff --git a/doc/guides/getting_started_guide/glossary.rst b/doc/guides/getting_started_guide/glossary.rst new file mode 100644 index 0000000000..29e3f041ba --- /dev/null +++ b/doc/guides/getting_started_guide/glossary.rst @@ -0,0 +1,78 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2025 Intel Corporation. + +Glossary +======== + +This glossary provides definitions for key terms and concepts used within DPDK. Understanding +these terms will help in comprehending the functionality and architecture of DPDK. + +.. glossary:: + + BIOS (Basic Input/Output System) + + The firmware used to perform hardware initialization during the booting process and to provide runtime services for operating systems and programs. + + :ref:`Bifurcated Driver ` + + A driver model that splits functionality between kernel and userspace, often used in high-performance networking. + + :ref:`Clang-LLVM ` + + A compiler toolchain that includes the Clang C compiler and LLVM linker, used for building DPDK on Windows. + + :ref:`contigmem Module ` + + A module in FreeBSD that provides physically contiguous memory allocation used by DPDK. + + :ref:`DMA (Direct Memory Access) ` + + A feature that allows hardware devices to access the main system memory directly, without involving the CPU. + + :ref:`EAL (Environment Abstraction Layer) ` + + The layer within DPDK that abstracts environmental specifics and provides a standard programming interface. + + :ref:`hugepages ` + + Large memory pages used by the operating system to manage memory more efficiently, especially in high-performance applications like DPDK. + + IOMMU (Input-Output Memory Management Unit) + + A hardware component that translates device-visible virtual addresses to physical addresses, providing memory protection and isolation. + + :ref:`MinGW-w64 Toolchain ` + + A development environment for creating Windows applications, used as an option for compiling DPDK on Windows. + + NIC (Network Interface Card) + + A hardware component that connects a computer to a network. + + :ref:`nic_uio Module ` + + A UIO driver for network devices in FreeBSD, used by DPDK. + + NUMA (Non-Uniform Memory Access) + + A computer memory design used in multiprocessing where the memory access time depends on the memory location relative to the processor. + + PMD (POLL Mode Driver) + + A type of driver in DPDK that continuously polls for events rather than relying on interrupts, often used for high-performance networking. + + SoC (System on a Chip) + + An integrated circuit that integrates all components of a computer or other electronic system into a single chip. + + :ref:`UIO (Userspace I/O) ` + + A Linux kernel module that enables user-space applications to access hardware devices directly. + + :ref:`VFIO (Virtual Function I/O) ` + + A kernel driver that allows a virtual machine to access physical devices directly, used in DPDK for device assignment. + + :ref:`VFIO Platform ` + + A framework in Linux that allows exposing direct device access to userspace, in a secure, IOMMU-protected way. -- 2.41.0.windows.1