PvRegIo.h
Go to the documentation of this file.
1 /*
2 |==============================================================================
3 | Copyright (C) 2006-2011 Allied Vision Technologies. All Rights Reserved.
4 |
5 | Redistribution of this header file, in original or modified form, without
6 | prior written consent of Allied Vision Technologies is prohibited.
7 |
8 |=============================================================================
9 |
10 | File: PvRegIo.h
11 |
12 | Project/lib: PvAPI
13 |
14 | Target: Win32, Linux, QNX
15 |
16 | Description: Camera register I/O.
17 |
18 | Notes: These functions can cause corruption to the internal state of
19 | PvAPI. Use with caution. Sample code provided for accessing
20 | certain registers. See siotest, CamMemory, GetXMLFile
21 |
22 |==============================================================================
23 |
24 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
25 | WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE,
26 | NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 | DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28 | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
30 | OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
33 | EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 |
35 |==============================================================================
36 | dd/mon/yy Notes
37 |------------------------------------------------------------------------------
38 | 10/Feb/06 Original.
39 | 04/Jun/07 Licence changes
40 |==============================================================================
41 */
42 
43 #ifndef PVREGIO_H_INCLUDE
44 #define PVREGIO_H_INCLUDE
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 //===== INCLUDE FILES =========================================================
51 
52 #include <prosilica_gige_sdk/PvApi.h>
53 
54 //===== #DEFINES ==============================================================
55 
56 #define PvRegisterRead _Pv_Factory_Test_10
57 #define PvRegisterWrite _Pv_Factory_Test_11
58 #define PvMemoryRead _Pv_Factory_Test_12
59 #define PvMemoryWrite _Pv_Factory_Test_13
60 
61 //===== TYPE DEFINITIONS ======================================================
62 
63 //===== FUNCTION PROTOTYPES ===================================================
64 
65 /*
66  * Function: PvRegisterRead()
67  *
68  * Purpose: Read camera registers. A backdoor command.
69  *
70  * Arguments:
71  *
72  * [ IN] tPvHandle Camera, Handle to the camera
73  * [ IN] unsigned long NumReads Number of registers to read
74  * [ IN] const unsigned long* pAddressArray, Array of addresses, NumReads long
75  * [OUT] unsigned long* pDataArray, Data is returned here; array
76  * must be NumReads long
77  * [OUT] unsigned long* pNumComplete, Number of registers successfully
78  * read; if an error occurs this
79  * is less than NumReads; may be
80  * NULL
81  *
82  * Return: ePvErrSuccess if no error, otherwise likely to be any of the
83  * following error codes:
84  *
85  * ePvErrBadHandle, the handle of the camera is invalid
86  * ePvErrUnplugged, the camera has been unplugged
87  * ePvBadParameter, NumReads is incorrect
88  * pPvAccessDenied, read is not permitted (or register does
89  * not exist)
90  */
91 tPvErr PVDECL _Pv_Factory_Test_10(tPvHandle Camera,
92  unsigned long NumReads,
93  const unsigned long* pAddressArray,
94  unsigned long* pDataArray,
95  unsigned long* pNumComplete);
96 
97 
98 /*
99  * Function: PvRegisterWrite()
100  *
101  * Purpose: Write camera registers. A backdoor command.
102  *
103  * Arguments:
104  *
105  * [ IN] tPvHandle Camera, Handle to the camera
106  * [ IN] unsigned long NumWrites Number of registers to write
107  * [ IN] const unsigned long* pAddressArray, Array of addresses, NumWrites long
108  * [ IN] const unsigned long* pDataArray, Array of data, NumWrites long
109  * [OUT] unsigned long* pNumComplete, Number of registers successfully
110  * written; if an error occurs this
111  * is less than NumWrites; may be
112  * NULL
113  *
114  * Return: ePvErrSuccess if no error, otherwise likely to be any of the
115  * following error codes:
116  *
117  * ePvErrBadHandle, the handle of the camera is invalid
118  * ePvErrUnplugged, the camera has been unplugged
119  * ePvBadParameter, NumWrites is incorrect
120  * pPvAccessDenied, write is not permitted (or register does
121  * not exist)
122  */
123 tPvErr PVDECL _Pv_Factory_Test_11(tPvHandle Camera,
124  unsigned long NumWrites,
125  const unsigned long* pAddressArray,
126  const unsigned long* pDataArray,
127  unsigned long* pNumComplete);
128 
129 
130 
131 /*
132  * Function: PvMemoryRead()
133  *
134  * Purpose: Read camera memory (READMEM_CMD). A backdoor command.
135  *
136  * Arguments:
137  *
138  * [ IN] tPvHandle Camera, Handle to the camera
139  * [ IN] unsigned long Address, Address
140  * [ IN] unsigned long Size, Size of read in bytes; must
141  * be a multiple of 4
142  * [OUT] unsigned char* pDataBuffer Data is returned here; buffer
143  * must be Size bytes long
144  *
145  * Return: ePvErrSuccess if no error, otherwise likely to be any of the
146  * following error codes:
147  *
148  * ePvErrBadHandle, the handle of the camera is invalid
149  * ePvErrUnplugged, the camera has been unplugged
150  * ePvBadParameter, Size is incorrect
151  * pPvAccessDenied, read is not permitted (or register does
152  * not exist)
153  */
154 tPvErr PVDECL _Pv_Factory_Test_12(tPvHandle Camera,
155  unsigned long Address,
156  unsigned long Size,
157  unsigned char* pDataBuffer);
158 
159 
160 /*
161  * Function: PvMemoryWrite()
162  *
163  * Purpose: Write camera memory (WRITEMEM_CMD). A backdoor command.
164  *
165  * Arguments:
166  *
167  * [ IN] tPvHandle Camera, Handle to the camera
168  * [ IN] unsigned long Address, Address
169  * [ IN] unsigned long Size, Size of write in bytes; must
170  * be a multiple of 4
171  * [ IN] const unsigned char* pDataBuffer, Data buffer, Size bytes long
172  * [OUT] unsigned long* pSizeComplete, Number of bytes successfully
173  * written; if an error occurs this
174  * is less than Size; may be
175  * NULL
176  *
177  * Return: ePvErrSuccess if no error, otherwise likely to be any of the
178  * following error codes:
179  *
180  * ePvErrBadHandle, the handle of the camera is invalid
181  * ePvErrUnplugged, the camera has been unplugged
182  * ePvBadParameter, Size is incorrect
183  * pPvAccessDenied, write is not permitted (or register does
184  * not exist)
185  */
186 tPvErr PVDECL _Pv_Factory_Test_13(tPvHandle Camera,
187  unsigned long Address,
188  unsigned long Size,
189  const unsigned char* pDataBuffer,
190  unsigned long* pSizeComplete);
191 
192 
193 //===== DATA ==================================================================
194 
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif // PVREGIO_H_INCLUDE
201 
_Pv_Factory_Test_13
tPvErr PVDECL _Pv_Factory_Test_13(tPvHandle Camera, unsigned long Address, unsigned long Size, const unsigned char *pDataBuffer, unsigned long *pSizeComplete)
_Pv_Factory_Test_10
tPvErr PVDECL _Pv_Factory_Test_10(tPvHandle Camera, unsigned long NumReads, const unsigned long *pAddressArray, unsigned long *pDataArray, unsigned long *pNumComplete)
tPvErr
tPvErr
Definition: PvApi.h:113
_Pv_Factory_Test_12
tPvErr PVDECL _Pv_Factory_Test_12(tPvHandle Camera, unsigned long Address, unsigned long Size, unsigned char *pDataBuffer)
tPvHandle
void * tPvHandle
Definition: PvApi.h:107
_Pv_Factory_Test_11
tPvErr PVDECL _Pv_Factory_Test_11(tPvHandle Camera, unsigned long NumWrites, const unsigned long *pAddressArray, const unsigned long *pDataArray, unsigned long *pNumComplete)

prosilica_gige_sdk
Author(s): Allied Vision Technologies.
autogenerated on Mon Jun 10 2019 14:14:24