1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/* Copyright (c) 2008-2012 Freescale Semiconductor, Inc
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Freescale Semiconductor nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
*
* ALTERNATIVELY, this software may be distributed under the terms of the
* GNU General Public License ("GPL") as published by the Free Software
* Foundation, either version 2 of that License or (at your option) any
* later version.
*
* THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**************************************************************************//**
@File memcpy_ext.h
@Description Efficient functions for copying and setting blocks of memory.
*//***************************************************************************/
#ifndef __MEMCPY_EXT_H
#define __MEMCPY_EXT_H
#include "std_ext.h"
/**************************************************************************//**
@Group etc_id Utility Library Application Programming Interface
@Description External routines.
@{
*//***************************************************************************/
/**************************************************************************//**
@Group mem_cpy Memory Copy
@Description Memory Copy module functions,definitions and enums.
@{
*//***************************************************************************/
/**************************************************************************//**
@Function MemCpy32
@Description Copies one memory buffer into another one in 4-byte chunks!
Which should be more efficient than byte by byte.
For large buffers (over 60 bytes) this function is about 4 times
more efficient than the trivial memory copy. For short buffers
it is reduced to the trivial copy and may be a bit worse.
@Param[in] pDst - The address of the destination buffer.
@Param[in] pSrc - The address of the source buffer.
@Param[in] size - The number of bytes that will be copied from pSrc to pDst.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non-null parameters as source & destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void * MemCpy32(void* pDst,void* pSrc, uint32_t size);
void * IO2IOCpy32(void* pDst,void* pSrc, uint32_t size);
void * IO2MemCpy32(void* pDst,void* pSrc, uint32_t size);
void * Mem2IOCpy32(void* pDst,void* pSrc, uint32_t size);
/**************************************************************************//**
@Function MemCpy64
@Description Copies one memory buffer into another one in 8-byte chunks!
Which should be more efficient than byte by byte.
For large buffers (over 60 bytes) this function is about 8 times
more efficient than the trivial memory copy. For short buffers
it is reduced to the trivial copy and may be a bit worse.
Some testing suggests that MemCpy32() preforms better than
MemCpy64() over small buffers. On average they break even at
100 byte buffers. For buffers larger than that MemCpy64 is
superior.
@Param[in] pDst - The address of the destination buffer.
@Param[in] pSrc - The address of the source buffer.
@Param[in] size - The number of bytes that will be copied from pSrc to pDst.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non null parameters as source & destination and size
that actually fits into their buffer.
Do not use under Linux.
*//***************************************************************************/
void * MemCpy64(void* pDst,void* pSrc, uint32_t size);
/**************************************************************************//**
@Function MemSet32
@Description Sets all bytes of a memory buffer to a specific value, in
4-byte chunks.
@Param[in] pDst - The address of the destination buffer.
@Param[in] val - Value to set destination bytes to.
@Param[in] size - The number of bytes that will be set to val.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non null parameter as destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void * MemSet32(void* pDst, uint8_t val, uint32_t size);
void * IOMemSet32(void* pDst, uint8_t val, uint32_t size);
/**************************************************************************//**
@Function MemSet64
@Description Sets all bytes of a memory buffer to a specific value, in
8-byte chunks.
@Param[in] pDst - The address of the destination buffer.
@Param[in] val - Value to set destination bytes to.
@Param[in] size - The number of bytes that will be set to val.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non null parameter as destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void * MemSet64(void* pDst, uint8_t val, uint32_t size);
/**************************************************************************//**
@Function MemDisp
@Description Displays a block of memory in chunks of 32 bits.
@Param[in] addr - The address of the memory to display.
@Param[in] size - The number of bytes that will be displayed.
@Return None.
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non null parameter as destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void MemDisp(uint8_t *addr, int size);
/**************************************************************************//**
@Function MemCpy8
@Description Trivial copy one memory buffer into another byte by byte
@Param[in] pDst - The address of the destination buffer.
@Param[in] pSrc - The address of the source buffer.
@Param[in] size - The number of bytes that will be copied from pSrc to pDst.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non-null parameters as source & destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void * MemCpy8(void* pDst,void* pSrc, uint32_t size);
/**************************************************************************//**
@Function MemSet8
@Description Sets all bytes of a memory buffer to a specific value byte by byte.
@Param[in] pDst - The address of the destination buffer.
@Param[in] c - Value to set destination bytes to.
@Param[in] size - The number of bytes that will be set to val.
@Return pDst (the address of the destination buffer).
@Cautions There is no parameter or boundary checking! It is up to the user
to supply non null parameter as destination and size
that actually fits into the destination buffer.
*//***************************************************************************/
void * MemSet8(void* pDst, int c, uint32_t size);
/** @} */ /* end of mem_cpy group */
/** @} */ /* end of etc_id group */
#endif /* __MEMCPY_EXT_H */
|
