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

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