Constants (GVL) ¶ InOut: Scope Name Type Initial Comment Constant PCI_MAX_BUSSES DINT 8 <description>Maxmimum number of PCI busses on the target</description> PCI_MAX_DEVICES DINT 32 <description>Maxmimum number of PCI devices on the bus</description> PCI_MAX_FUNCTIONS DINT 8 <description>Maximum number of functions</description>
PCI_INFO (STRUCT) ¶ TYPE PCI_INFO : STRUCT <category>PCI_INFO</category> <description><p> PCI information entry of one device. This structure contains information on design, behavior and memory requirement of the PCI card. The components are filled in by the card itself or by the PCI bus. </p></description> InOut: Name Type Comment usVendorID WORD <param name=”usVendorID” type=”IN”>Registered Vendor ID of card assigned by PCI SIG</param> usDeviceID WORD <param name=”usDeviceID” type=”IN”>Device ID of card assigned by manufacturer</param> usSubVendorID WORD <param name=”usSubVendorID” type=”IN”>Registered subsystem vendor ID assigned by PCI SIG</param> usSubSystemID WORD <param name=”usSubSystemID” type=”IN”>Subsystem device ID assigned by manufacturer, if there are multiple subsystems on card. The value 0 indicates that there are no subsystems.</param> ulBusNr DWORD <param name=”ulBusNr” type=”IN”>PCI bus number the PCI card is member of</param> SlotNr DWORD <param name=”SlotNr” type=”IN”>PCI slot number (within bus) the PCI card is plugged in</param> ulFunction DWORD <param name=”ulFunction” type=”IN”>PCI function number</param> ulBaseAddresses ARRAY [0..5] OF DWORD <param name=”ulBaseAddresses” type=”IN”>Basis address register for reservation of I/O port addresses or I/O memory areas (Memory Mapped I/O); Specific for particular card.</param> byInterrupt BYTE <param name=”byInterrupt” type=”IN”>Identifies the interrupt vector on the particular system</param> DeviceSpecific ARRAY [0..191] OF BYTE <param name=”DeviceSpecific” type=”IN”>According to PCI specification the 192 manufacture specific data bytes</param>
SysPciGetCardInfo (FUN) ¶ FUNCTION SysPciGetCardInfo : RTS_IEC_RESULT <description>Get PCI info of a specified card. This function retrieves information on a PCI card that is identified by its vendor ID, its device ID and its card index. Therefore, SysPciGetCardInfo returns a pointer to a variable of type PCI_INFO containing the information on the PCI card. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysPciGetCardInfo RTS_IEC_RESULT Input usVendorId WORD <param name=”usVendorId” type=”IN”>PCI vendor number</param> usDeviceId WORD <param name=”usDeviceId” type=”IN”>PCI device Id</param> usCardIndex WORD <param name=”usCardIndex” type=”IN”>Card index number</param> pPciInfo POINTER TO PCI_INFO <param name=”pPciInfo” type=”OUT”>PCI entry</param>
SysPciGetConfigEntry (FUN) ¶ FUNCTION SysPciGetConfigEntry : RTS_IEC_RESULT <description>Get one PCI config entry. This function allows to read the configuration data of a PCI card. The data is stored in a structure of type PCI_INFO and filled into the PCI bus. By means of the bus, device and function number SysPciGetConfigEntry identifies the associated bus entry and returns a pointer to it. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysPciGetConfigEntry RTS_IEC_RESULT Input usBus WORD <param name=”usBus” type=”IN”>PCI bus number (index)</param> usDevice WORD <param name=”usDevice” type=”IN”>PCI device number (index)</param> usFunction WORD <param name=”usFunction” type=”IN”>PCI function number (index)</param> pPciInfo POINTER TO PCI_INFO <param name=”pPciInfo” type=”OUT”>Pointer to structure PCI_INFO containing information on the PCI card</param>
SysPciReadValue (FUN) ¶ FUNCTION SysPciReadValue : RTS_IEC_RESULT <description>Read one PCI config value This function allows to read single configuration values of a PCI card by returning a pointer on the associated memory address (pbyData). Thereby the associated bus entry is identified via the bus, device and function number. The component to be read out is indicated by the PciOffset. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysPciReadValue RTS_IEC_RESULT Input usBus WORD <param name=”usBus” type=”IN”>PCI bus number (index)</param> usDevice WORD <param name=”usDevice” type=”IN”>PCI device number (index)</param> usFunction WORD <param name=”usFunction” type=”IN”>PCI function number (index)</param> usPciOffset WORD <param name=”usPciOffset” type=”IN”>Offset in the PCI config</param> pbyData POINTER TO BYTE <param name=”pbyData” type=”OUT”>Pointer to data to read to PCI</param> usSize WORD <param name=”usSize” type=”IN”>Size in byte of data to read</param>
SysPciSetConfigEntry (FUN) ¶ FUNCTION SysPciSetConfigEntry : RTS_IEC_RESULT <description>Set one PCI config entry. This function allows to write an entry to the PCI bus. The entry is a structure of type PCI-INFO and is transmitted to the function SysPciSetConfigEntry via a pointer on it. The structure contains the configuration data of the PCI card being identified by the bus, device and function number. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysPciSetConfigEntry RTS_IEC_RESULT Input usBus WORD <param name=”usBus” type=”IN”>PCI bus number (index)</param> usDevice WORD <param name=”usDevice” type=”IN”>PCI device number (index)</param> usFunction WORD <param name=”usFunction” type=”IN”>PCI function number (index)</param> pPciInfo POINTER TO PCI_INFO <param name=”pPciInfo” type=”IN”>Pointer to structure PCI_INFO containing information on the PCI card</param>
SysPciWriteValue (FUN) ¶ FUNCTION SysPciWriteValue : RTS_IEC_RESULT <description>Write one PCI config value This function allows to set single configuration values of a PCI card via a pointer on the corresponding memory address (pbyData). Therefore the bus entry associated to the PCI card is identified via the bus, device and function number. The bus entry is a structure of type PCI_INFO. The component to be read out is indicated by PciOffset. </description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysPciWriteValue RTS_IEC_RESULT Input usBus WORD <param name=”usBus” type=”IN”>PCI bus number (index)</param> usDevice WORD <param name=”usDevice” type=”IN”>PCI device number (index)</param> usFunction WORD <param name=”usFunction” type=”IN”>PCI function number (index)</param> usPciOffset WORD <param name=”usPciOffset” type=”IN”>Offset in the PCI config entry</param> pbyData POINTER TO BYTE <param name=”pbyData” type=”IN”>Pointer to data to write to PCI</param> usSize WORD <param name=”usSize” type=”IN”>Size in byte of data to write</param>
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 16:04:34 companyName string 3S-Smart Software Solutions GmbH libraryFile SysPci.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysPci.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 16:04:34 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder SysPci Project SysPci Title SysPci Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
SysPci23 Library Documentation ¶ Company System Title SysPci23 Version 3.5.13.0 Categories System|SysLibs23 Author 3S - Smart Software Solutions GmbH Description 1 ¶ Compatibility library for CoDeSys 2.3 projects, to get access to the pci card. Contents: ¶ Data types PCI_INFO (Struct) SysPciGetCardInfo (Function) extern30 Constants (GVL) GVL (GVL) SysPciGetCardInfo30 (Function) Indices and tables ¶ 1 Based on SysPci23.library, last modified 03.07.2018, 10:35:02. LibDoc 4.4.0.0-b.27 The content file SysPci23.clean.json was generated with CODESYS V3.5 SP13 on 03.07.2018, 10:35:02.