[mirror_edk2.git] / MdePkg / Library / PeiMemoryLib / MemLibInternals.h

/** @file\r
  Declaration of internal functions for Base Memory Library.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Module Name:  MemLibInternals.h\r
\r
  The following BaseMemoryLib instances share the same version of this file:\r
\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    PeiMemoryLib\r
    DxeMemoryLib\r
\r
**/\r
\r
#ifndef __MEM_LIB_INTERNALS__\r
#define __MEM_LIB_INTERNALS__\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiPei.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
\r
/**\r
  Copy Length bytes from Source to Destination.\r
\r
  @param  Destination Target of copy\r
  @param  Source Place to copy from\r
  @param  Length Number of bytes to copy\r
\r
  @return Destination\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemCopyMem (\r
  OUT     VOID                      *DestinationBuffer,\r
  IN      CONST VOID                *SourceBuffer,\r
  IN      UINTN                     Length\r
  );\r
\r
/**\r
  Set Buffer to Value for Size bytes.\r
\r
  @param  Buffer Memory to set.\r
  @param  Size Number of bytes to set\r
  @param  Value Value of the set operation.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT8                     Value\r
  );\r
\r
/**\r
  Fills a target buffer with a 16-bit value, and returns the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to fill.\r
  @param  Length  Number of bytes in Buffer to fill.\r
  @param  Value   Value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem16 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT16                    Value\r
  );\r
\r
/**\r
  Fills a target buffer with a 32-bit value, and returns the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to fill.\r
  @param  Length  Number of bytes in Buffer to fill.\r
  @param  Value   Value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem32 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT32                    Value\r
  );\r
\r
/**\r
  Fills a target buffer with a 64-bit value, and returns the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to fill.\r
  @param  Length  Number of bytes in Buffer to fill.\r
  @param  Value   Value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem64 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT64                    Value\r
  );\r
\r
/**\r
  Set Buffer to 0 for Size bytes.\r
\r
  @param  Buffer Memory to set.\r
  @param  Size Number of bytes to set\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemZeroMem (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length\r
  );\r
\r
/**\r
  Compares two memory buffers of a given length.\r
\r
  @param  DestinationBuffer First memory buffer\r
  @param  SourceBuffer      Second memory buffer\r
  @param  Length            Length of DestinationBuffer and SourceBuffer memory\r
                            regions to compare. Must be non-zero.\r
\r
  @retval 0     if MemOne == MemTwo\r
\r
**/\r
INTN\r
EFIAPI\r
InternalMemCompareMem (\r
  IN      CONST VOID                *DestinationBuffer,\r
  IN      CONST VOID                *SourceBuffer,\r
  IN      UINTN                     Length\r
  );\r
\r
/**\r
  Scans a target buffer for an 8-bit value, and returns a pointer to the\r
  matching 8-bit value in the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to scan.\r
  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
  @param  Value   Value to search for in the target buffer.\r
\r
  @return Pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem8 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT8                     Value\r
  );\r
\r
/**\r
  Scans a target buffer for a 16-bit value, and returns a pointer to the\r
  matching 16-bit value in the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to scan.\r
  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
  @param  Value   Value to search for in the target buffer.\r
\r
  @return Pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem16 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT16                    Value\r
  );\r
\r
/**\r
  Scans a target buffer for a 32-bit value, and returns a pointer to the\r
  matching 32-bit value in the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to scan.\r
  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
  @param  Value   Value to search for in the target buffer.\r
\r
  @return Pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem32 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT32                    Value\r
  );\r
\r
/**\r
  Scans a target buffer for a 64-bit value, and returns a pointer to the\r
  matching 64-bit value in the target buffer.\r
\r
  @param  Buffer  Pointer to the target buffer to scan.\r
  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
  @param  Value   Value to search for in the target buffer.\r
\r
  @return Pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem64 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT64                    Value\r
  );\r
\r
#endif\r
Commit	Line	Data
dd51a993	1	/** @file\r
	2	Declaration of internal functions for Base Memory Library.\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation<BR>\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	Module Name: MemLibInternals.h\r
	14	\r
	15	The following BaseMemoryLib instances share the same version of this file:\r
	16	\r
	17	BaseMemoryLib\r
	18	BaseMemoryLibMmx\r
	19	BaseMemoryLibSse2\r
	20	BaseMemoryLibRepStr\r
	21	PeiMemoryLib\r
	22	DxeMemoryLib\r
	23	\r
	24	**/\r
	25	\r
	26	#ifndef __MEM_LIB_INTERNALS__\r
	27	#define __MEM_LIB_INTERNALS__\r
	28	\r
bad46384	29	//\r
	30	// The package level header files this module uses\r
	31	//\r
	32	#include <PiPei.h>\r
	33	//\r
	34	// The Library classes this module consumes\r
	35	//\r
	36	#include <Library/BaseMemoryLib.h>\r
	37	#include <Library/PeiServicesTablePointerLib.h>\r
	38	#include <Library/DebugLib.h>\r
	39	#include <Library/BaseLib.h>\r
	40	\r
dd51a993	41	/**\r
	42	Copy Length bytes from Source to Destination.\r
	43	\r
	44	@param Destination Target of copy\r
	45	@param Source Place to copy from\r
	46	@param Length Number of bytes to copy\r
	47	\r
	48	@return Destination\r
	49	\r
	50	**/\r
	51	VOID *\r
	52	EFIAPI\r
	53	InternalMemCopyMem (\r
	54	OUT VOID *DestinationBuffer,\r
	55	IN CONST VOID *SourceBuffer,\r
	56	IN UINTN Length\r
	57	);\r
	58	\r
	59	/**\r
	60	Set Buffer to Value for Size bytes.\r
	61	\r
	62	@param Buffer Memory to set.\r
	63	@param Size Number of bytes to set\r
	64	@param Value Value of the set operation.\r
	65	\r
	66	@return Buffer\r
	67	\r
	68	**/\r
	69	VOID *\r
	70	EFIAPI\r
	71	InternalMemSetMem (\r
	72	OUT VOID *Buffer,\r
	73	IN UINTN Length,\r
	74	IN UINT8 Value\r
	75	);\r
	76	\r
	77	/**\r
	78	Fills a target buffer with a 16-bit value, and returns the target buffer.\r
	79	\r
	80	@param Buffer Pointer to the target buffer to fill.\r
	81	@param Length Number of bytes in Buffer to fill.\r
	82	@param Value Value with which to fill Length bytes of Buffer.\r
	83	\r
	84	@return Buffer\r
	85	\r
	86	**/\r
	87	VOID *\r
	88	EFIAPI\r
	89	InternalMemSetMem16 (\r
	90	OUT VOID *Buffer,\r
	91	IN UINTN Length,\r
	92	IN UINT16 Value\r
	93	);\r
	94	\r
	95	/**\r
	96	Fills a target buffer with a 32-bit value, and returns the target buffer.\r
	97	\r
	98	@param Buffer Pointer to the target buffer to fill.\r
	99	@param Length Number of bytes in Buffer to fill.\r
	100	@param Value Value with which to fill Length bytes of Buffer.\r
	101	\r
	102	@return Buffer\r
	103	\r
	104	**/\r
105	VOID *\r
106	EFIAPI\r
107	InternalMemSetMem32 (\r
108	OUT VOID *Buffer,\r
109	IN UINTN Length,\r
110	IN UINT32 Value\r
111	);\r
112	\r
113	/**\r
114	Fills a target buffer with a 64-bit value, and returns the target buffer.\r
115	\r
116	@param Buffer Pointer to the target buffer to fill.\r
117	@param Length Number of bytes in Buffer to fill.\r
118	@param Value Value with which to fill Length bytes of Buffer.\r
119	\r
120	@return Buffer\r
121	\r
122	**/\r
123	VOID *\r
124	EFIAPI\r
125	InternalMemSetMem64 (\r
126	OUT VOID *Buffer,\r
127	IN UINTN Length,\r
128	IN UINT64 Value\r
129	);\r
130	\r
131	/**\r
132	Set Buffer to 0 for Size bytes.\r
133	\r
134	@param Buffer Memory to set.\r
135	@param Size Number of bytes to set\r
136	\r
137	@return Buffer\r
138	\r
139	**/\r
140	VOID *\r
141	EFIAPI\r
142	InternalMemZeroMem (\r
143	OUT VOID *Buffer,\r
144	IN UINTN Length\r
145	);\r
146	\r
147	/**\r
148	Compares two memory buffers of a given length.\r
149	\r
150	@param DestinationBuffer First memory buffer\r
151	@param SourceBuffer Second memory buffer\r
152	@param Length Length of DestinationBuffer and SourceBuffer memory\r
153	regions to compare. Must be non-zero.\r
154	\r
155	@retval 0 if MemOne == MemTwo\r
156	\r
157	**/\r
158	INTN\r
159	EFIAPI\r
160	InternalMemCompareMem (\r
161	IN CONST VOID *DestinationBuffer,\r
162	IN CONST VOID *SourceBuffer,\r
163	IN UINTN Length\r
164	);\r
165	\r
166	/**\r
167	Scans a target buffer for an 8-bit value, and returns a pointer to the\r
168	matching 8-bit value in the target buffer.\r
169	\r
170	@param Buffer Pointer to the target buffer to scan.\r
171	@param Length Number of bytes in Buffer to scan. Must be non-zero.\r
172	@param Value Value to search for in the target buffer.\r
173	\r
174	@return Pointer to the first occurrence or NULL if not found.\r
175	\r
176	**/\r
177	CONST VOID *\r
178	EFIAPI\r
179	InternalMemScanMem8 (\r
180	IN CONST VOID *Buffer,\r
181	IN UINTN Length,\r
182	IN UINT8 Value\r
183	);\r
184	\r
185	/**\r
186	Scans a target buffer for a 16-bit value, and returns a pointer to the\r
187	matching 16-bit value in the target buffer.\r
188	\r
189	@param Buffer Pointer to the target buffer to scan.\r
190	@param Length Number of bytes in Buffer to scan. Must be non-zero.\r
191	@param Value Value to search for in the target buffer.\r
192	\r
193	@return Pointer to the first occurrence or NULL if not found.\r
194	\r
195	**/\r
196	CONST VOID *\r
197	EFIAPI\r
198	InternalMemScanMem16 (\r
199	IN CONST VOID *Buffer,\r
200	IN UINTN Length,\r
201	IN UINT16 Value\r
202	);\r
203	\r
204	/**\r
205	Scans a target buffer for a 32-bit value, and returns a pointer to the\r
206	matching 32-bit value in the target buffer.\r
207	\r
208	@param Buffer Pointer to the target buffer to scan.\r
209	@param Length Number of bytes in Buffer to scan. Must be non-zero.\r
210	@param Value Value to search for in the target buffer.\r
211	\r
212	@return Pointer to the first occurrence or NULL if not found.\r
213	\r
214	**/\r
215	CONST VOID *\r
216	EFIAPI\r
217	InternalMemScanMem32 (\r
218	IN CONST VOID *Buffer,\r
219	IN UINTN Length,\r
220	IN UINT32 Value\r
221	);\r
222	\r
223	/**\r
224	Scans a target buffer for a 64-bit value, and returns a pointer to the\r
225	matching 64-bit value in the target buffer.\r
226	\r
227	@param Buffer Pointer to the target buffer to scan.\r
228	@param Length Number of bytes in Buffer to scan. Must be non-zero.\r
229	@param Value Value to search for in the target buffer.\r
230	\r
231	@return Pointer to the first occurrence or NULL if not found.\r
232	\r
233	**/\r
234	CONST VOID *\r
235	EFIAPI\r
236	InternalMemScanMem64 (\r
237	IN CONST VOID *Buffer,\r
238	IN UINTN Length,\r
239	IN UINT64 Value\r
240	);\r
241	\r
242	#endif\r