CmpCharDevice Implementation Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title CmpCharDevice Implementation Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpCharDevice Implementation Description 1 ¶ Linux Library to access character devices Contents: ¶ CDClose (Function) CDIoctl (Function) CDLseek (Function) CDMmap (Function) CDMunmap (Function) CDOpen (Function) CDRead (Function) CDWrite (Function) Indices and tables ¶ 1 Based on CmpCharDevice Implementation.library, last modified 20.04.2021, 15:37:28. LibDoc 4.4.0.0-b.27 The content file CmpCharDevice Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:37:28.

CDClose (FUN) ¶ FUNCTION CDClose : DINT Close a character device file. InOut: Scope Name Type Comment Return CDClose DINT 0 on success Input hFile RTS_IEC_HANDLE File descriptor/handle, that was previously created with Open() pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDIoctl (FUN) ¶ FUNCTION CDIoctl : DINT Control a character device file. This function manipulates the underlying device parameters of special files. InOut: Scope Name Type Comment Return CDIoctl DINT 0 if ok or errno if failed. Input hFile RTS_IEC_HANDLE File descriptor/handle, that was previously created with Open() dRequest __XWORD Request id. dParameter __XWORD Request parameter. pResult POINTER TO DINT Pointer to linux errno error code

CDLseek (FUN) ¶ FUNCTION CDLseek : DINT Repositions the file offset of an open file. lseek() sets the file offset of hFile to the argument offset according to the directive whence InOut: Scope Name Type Comment Return CDLseek DINT the resulting offset location as measured in bytes from the beginning of the file or -1 if failed. Input hFile RTS_IEC_HANDLE File descriptor/handle, that was previously created with Open() offset DINT offset in bytes whence DINT one of the following flags: SEEK_SET: The file offset is set to offset bytes SEEK_CUR: The file offset is set to its current location plus offset bytes SEEK_END:The file offset is set to the size of the file plus offset pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDMmap (FUN) ¶ FUNCTION CDMmap : POINTER TO BYTE Map files or devices into memory. mmap() creates a new mapping in the virtual address space of the calling process. InOut: Scope Name Type Comment Return CDMmap POINTER TO BYTE pointer to the mapped area, or MAP_FAILED if failed. Input addr POINTER TO BYTE Pointer to starting address for the new mapping length UDINT Number of bytes mapped prot DINT Memory protection of the mapping. It is either PROT_NONE or the bitwise OR of one or more of the following flags: PROT_EXEC: Pages may be executed PROT_READ: Pages may be read PROT_WRITE: Pages may be written PROT_NONE: Pages may not be accessed flags DINT one of the following flags MAP_SHARED: Share this mapping MAP_SHARED_VALIDATE: This flag provides the same behavior as MAP_SHARED except that MAP_SHARED mappings ignore unknown flags in flags MAP_PRIVATE: Create a private copy-on-write mapping Optional flags for mmap: See linux man page for Details hFile RTS_IEC_HANDLE File descriptor of the file to be mapped offset DINT Offset in the file (or other object) where mapping starts pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDMunmap (FUN) ¶ FUNCTION CDMunmap : DINT Unmap files or devices into memory. The munmap() system call deletes the mappings for the specified address range. InOut: Scope Name Type Comment Return CDMunmap DINT 0 on success, -1 if failed. Input addr POINTER TO BYTE Pointer to starting address length UDINT Number of bytes mapped pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDOpen (FUN) ¶ FUNCTION CDOpen : RTS_IEC_HANDLE Open a character device file. Given a pathname for a file, open() returns a file descriptor handle for use in subsequent system calls (read(), write(), ioctl(), etc.). InOut: Scope Name Type Comment Return CDOpen RTS_IEC_HANDLE Handle or RTS_INVALID_HANDLE if failed. Input szFile STRING(80) File name. File name must be an absolute path to the file. Path entries must be separated with a ‘/’ and not with a ‘"! dFlags DINT Requested ACCESS_MODE for fileaccess: dwFlags must include one of the following flags: O_RDONLY: read-only access O_WRONLY: write-only access O_RDWR: read/write access Optional flags for fileaccess: See linux man page for Details pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDRead (FUN) ¶ FUNCTION CDRead : DINT Read from a character device file. Read() attempts to read up to count bytes from file handle hFile into the buffer starting at buf. InOut: Scope Name Type Comment Return CDRead DINT Nr of Bytes copied. Input hFile RTS_IEC_HANDLE File descriptor/handle, that was previously created with Open() pbyBuffer POINTER TO BYTE Buffer to copy bytes into. udCount UDINT Nr of bytes to copy. pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

CDWrite (FUN) ¶ FUNCTION CDWrite : DINT Write to a character device file. Write() attempts to write up to count bytes from file handle hFile into the buffer starting at buf. InOut: Scope Name Type Comment Return CDWrite DINT Nr of Bytes copied. Input hFile RTS_IEC_HANDLE File descriptor/handle, that was previously created with open() pbyBuffer POINTER TO BYTE Buffer to copy bytes from. udCount UDINT Nr of bytes to copy. pResult POINTER TO DINT Pointer to linux errno error code, 0 is ok

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:37:28 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpCharDevice Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpCharDevice Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True LastModificationDateTime date 20.04.2021, 15:37:28 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder CmpCharDevice Implementation Project CmpCharDevice Implementation Title CmpCharDevice Implementation Version version 3.5.17.0