Device.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Device Abstraction Utility Routines
Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available
under the terms and conditions of the BSD License which accompanies this
distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Depends upon: <kfile.h>
**/
#ifndef __DEV_UTILITY_H__
#define __DEV_UTILITY_H__
typedef enum {
PathAbsolute = 0,
} PATH_CLASS;
typedef struct _Device_Node {
void *InstanceList; ///< Array of instances for this device
} DeviceNode;
/** Add a new device to the device list.
@param DevName Name of the device to add.
@param DevProto Pointer to the GUID identifying the protocol associated with this device.
If DevProto is NULL, startup code will not try to find instances
of this device.
@param OpenFunc Pointer to the device's Open function.
@param InstanceList Optional pointer to the device's initialized instance list.
If InstanceList is NULL, the application startup code will
scan for instances of the protocol identified by DevProto and
populate the InstanceList in the order those protocols are found.
@param NumInstance Number of instances in InstanceList.
@param Modes Bit-mapped flags indicating operations (R, W, RW, ...) permitted to this device.
**/
/** Find a DeviceNode matching DevName or DevProto, or both.
If DevName is NULL, then the device name is not used in the search.
If DevProto is NULL, then the protocol GUID is not used in the search.
If both are NULL, then INVALID_PARAMETER is returned.
If both DevName and DevProto are specified, then both must match.
If both are specified but only one matches, then DEVICE_ERROR is returned.
@param DevName Name of the Device Abstraction to find.
@param DevProto GUID of the Protocol associated with the Device Abstraction.
@param Node Pointer to the pointer to receive the found Device Node's address.
@retval RETURN_SUCCESS The desired Device Node was found.
@retval RETURN_INVALID_PARAMETER Both DevName and DevProto are NULL or Node is NULL.
@retval RETURN_DEVICE_ERROR One, but not both, of DevNode and DevProto matched.
**/
/** Identify the type of path pointed to by Path.
Paths are classified based upon their initial character sequences.
^\\ Absolute Path
^\. Relative Path
^[^:\\]: Mapping Path
.* Relative Path
Mapping paths are broken into two parts at the ':'. The part to the left of the ':'
is the Map Name, pointed to by Path, and the part to the right of the ':' is pointed
to by NewPath.
If Path was not a Mapping Path, then NewPath is set to Path.
@param[in] Path Pointer to the path to be classified.
@param[out] NewPath Pointer to the path portion of a mapping path.
@retval PathAbsolute Path is an absolute path. NewPath points to the first '\'.
@retval PathRelative Path is a relative path. NewPath = Path.
@retval PathMapping Path is a mapping path. NewPath points to the ':'.
@retval PathError Path is NULL.
**/
/* Normalize a narrow-character path and produce a wide-character path
that has forward slashes replaced with backslashes.
Backslashes are directory separators in UEFI File Paths.
It is the caller's responsibility to eventually free() the returned buffer.
@param[in] path A pointer to the narrow-character path to be normalized.
@return A pointer to a buffer containing the normalized, wide-character, path.
*/
wchar_t *
NormalizePath( const char *path);
/** Process a MBCS path returning the final absolute path and the target device.
@param path
@param FullPath
@param DevNode
@retval RETURN_SUCCESS
@retval RETURN_INVALID_PARAMETER
@retval RETURN_NOT_FOUND
**/
ParsePath( const char *path, wchar_t **FullPath, DeviceNode **DevNode, int *Which, wchar_t **MapPath);
/** Process a wide character string representing a Mapping Path and extract the instance number.
The instance number is the sequence of decimal digits immediately to the left
of the ":" in the Map Name portion of a Mapping Path.
This function is called with a pointer to beginning of the Map Name.
Thus Path[Length] must be a ':' and Path[Length - 1] must be a decimal digit.
If either of these are not true, an instance value of 0 is returned.
If Path is NULL, an instance value of 0 is returned.
@param[in] Path Points to the beginning of a Mapping Path
@param[in] Length Number of valid characters to the left of the ':'
@return Returns either 0 or the value of the contiguous digits to the left of the ':'.
**/
int
/** Transform a relative path into an absolute path.
If Path is NULL, return NULL.
Otherwise, pre-pend the CWD to Path then process the resulting path to:
- Replace "/./" with "/"
- Replace "/<dirname>/../" with "/"
- Do not allow one to back up past the root, "/"
Also sets the Current Working Device to the Root Device.
Path must be a previously allocated buffer. PathAdjust will
allocate a new buffer to hold the results of the transformation
then free Path. A pointer to the newly allocated buffer is returned.
@param[in] Path A pointer to the path to be transformed. This buffer
will always be freed.
@return A pointer to a buffer containing the transformed path.
**/
wchar_t *
/** Replace the leading portion of Path with any aliases.
Current Working Device is set to that device.
Path must be a previously allocated buffer. PathAlias will
allocate a new buffer to hold the results of the transformation
then free Path. A pointer to the newly allocated buffer is returned.
@param[in] Path A pointer to the original, unaliased, path. This
buffer is always freed.
@param[out] Node Filled in with a pointer to the Device Node describing
the device abstraction associated with this path.
@return A pointer to a buffer containing the aliased path.
**/
wchar_t *
/**
Parses a normalized wide character path and returns a pointer to the entry
following the last \. If a \ is not found in the path the return value will
be the same as the input value. All error conditions return NULL.
The behavior when passing in a path that has not been normalized is undefined.
@param Path - A pointer to a wide character string containing a path to a
directory or a file.
@return Pointer to the file name or terminal directory. NULL if an error is
detected.
**/
wchar_t *
);
#endif /* __DEV_UTILITY_H__ */