summaryrefslogtreecommitdiffstats
path: root/StdLibPrivateInternalFiles
diff options
context:
space:
mode:
authorDaryl McDaniel <edk2-lists@mc2research.org>2016-01-06 00:31:42 +0000
committerdarylm503 <darylm503@Edk2>2016-01-06 00:31:42 +0000
commit450ea6d5b69cffd2b6c2154fdbeec5bf60c8c858 (patch)
treec25268572cb9f92728bd822d4d2b58a79830bf38 /StdLibPrivateInternalFiles
parent4e8f2b290e92891b4248cc680d6751b73331d545 (diff)
downloadedk2-450ea6d5b69cffd2b6c2154fdbeec5bf60c8c858.tar.gz
edk2-450ea6d5b69cffd2b6c2154fdbeec5bf60c8c858.tar.bz2
edk2-450ea6d5b69cffd2b6c2154fdbeec5bf60c8c858.zip
StdLib: Clarify and improve comments.
Indentation has been corrected in all of the files. LibC/Locale/multibyte_Utf8.c LibC/Uefi/SysCalls.c Clarify and improve comments. Include/sys/termios.h Add parameter names to function prototypes as referenced in the comments. StdLibPrivateInternalFiles\Include\kfile.h Add comment for the fo_close fileop. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Daryl McDaniel <edk2-lists@mc2research.org> Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@19588 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'StdLibPrivateInternalFiles')
-rw-r--r--StdLibPrivateInternalFiles/Include/kfile.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/StdLibPrivateInternalFiles/Include/kfile.h b/StdLibPrivateInternalFiles/Include/kfile.h
index 6312895c40..67bff56cc6 100644
--- a/StdLibPrivateInternalFiles/Include/kfile.h
+++ b/StdLibPrivateInternalFiles/Include/kfile.h
@@ -102,7 +102,13 @@ struct __filedes {
struct fileops {
/* These functions must always be implemented. */
+
+ /** Perform device specific operations for closing the device.
+ It is the responsibility of this function to flush or discard
+ buffer contents.
+ **/
int (EFIAPI *fo_close) (struct __filedes *filp);
+
ssize_t (EFIAPI *fo_read) (struct __filedes *filp, off_t *Offset, size_t Len, void *Buf);
ssize_t (EFIAPI *fo_write) (struct __filedes *filp, off_t *Offset, size_t Len, const void *Buf);
@@ -123,7 +129,7 @@ struct fileops {
off_t (EFIAPI *fo_lseek) (struct __filedes *filp, off_t, int);
};
-/* A generic instance structure which is valid for
+/* A generic instance structure which is valid
for all device instance structures.
All device instance structures MUST be a multiple of 8-bytes in length.