--- libaitpelco/inc/aitpelco.h 2010/01/22 00:57:32 1.1 +++ libaitpelco/inc/aitpelco.h 2013/05/30 09:20:16 1.4 @@ -3,9 +3,46 @@ * by Michael Pounov * * $Author: misho $ -* $Id: aitpelco.h,v 1.1 2010/01/22 00:57:32 misho Exp $ +* $Id: aitpelco.h,v 1.4 2013/05/30 09:20:16 misho Exp $ * -*************************************************************************/ +************************************************************************** +The ELWIX and AITNET software is distributed under the following +terms: + +All of the documentation and software included in the ELWIX and AITNET +Releases is copyrighted by ELWIX - Sofia/Bulgaria + +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 + by Michael Pounov . All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. 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. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: +This product includes software developed by Michael Pounov +ELWIX - Embedded LightWeight unIX and its contributors. +4. Neither the name of AITNET nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``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 THE REGENTS OR CONTRIBUTORS 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. +*/ #ifndef __AITPELCO_H #define __AITPELCO_H @@ -110,9 +147,9 @@ typedef struct tagPelcoP { // ------------------------------------------------------- // pelco_GetErrno() Get error code of last operation -inline int pelco_GetErrno(); +int pelco_GetErrno(); // pelco_GetError() Get error text of last operation -inline const char *pelco_GetError(); +const char *pelco_GetError(); // ------------------------------------------------------- @@ -122,30 +159,55 @@ inline const char *pelco_GetError(); * @camNo = Packet for camera number address * return: NULL error, !=NULL ok, allocated memory for packet */ -inline void *pelcoOpen(u_char pelcoVer, u_char camNo); +void *pelcoOpen(u_char pelcoVer, u_char camNo); /* * pelcoClose() Close packet record and free memory * @p = Packet structure for close */ -inline void pelcoClose(void * __restrict p); +void pelcoClose(void * __restrict p); /* + * pelcoLoad() Load packet from input buffer + * @buffer = Pelco packet from input buffer + * return: NULL error, !=NULL ok, allocated memory for packet + */ +void *pelcoLoad(u_char *buffer); + + +/* * pelcoAddCmdData() Add commands and datas for already opened packet * @p = Input Packet structure * @cmd[2] = Input Commands 1 & 2 * @data[2] = Input Data for commands 1 & 2 * return: 0xFF - error, 0 - ok */ -inline u_char pelcoAddCmdData(void * __restrict p, u_char * __restrict cmd, u_char * __restrict data); +u_char pelcoAddCmdData(void * __restrict p, u_char * __restrict cmd, u_char * __restrict data); +/* + * pelcoGetCmdData() Get from packet commands and datas with verify packet + * @p = Input Packet structure + * @cmd[2] = Output Commands 1 & 2 + * @data[2] = Output Data for commands 1 & 2 + * return: 'd' - PelcoD, 'p' - PelcoP, 0 - unknown or bad packet + */ +u_char pelcoGetCmdData(void * __restrict p, u_char * __restrict cmd, u_char * __restrict data); /* + * pelcoChkSum() Check ot Correct check sum in packet + * @p = Input Packet structure + * @correct = Calculate new check sum if incorrect !=0, if ==0 only check + * return: 0xFF - bad packet, invalid check sum, 0 check sum is correct. + */ +u_char pelcoChkSum(void * __restrict p, u_char correct); + + +/* * pelco_GetVersion() Return Pelco protocol version * @p = Packet structure * return: 'd' - PelcoD, 'p' - PelcoP, 0 - unknown or bad packet */ -inline u_char pelco_GetVersion(void * __restrict p); +u_char pelco_GetVersion(void * __restrict p); /* * pelco_GetCamNo() Get Camera number and check for valid packet @@ -153,7 +215,7 @@ inline u_char pelco_GetVersion(void * __restrict p); * return: 0xFF and pelco_GetErrno() == ENOEXEC - error, any number is camera address */ -inline u_char pelco_GetCamNo(void * __restrict p); +u_char pelco_GetCamNo(void * __restrict p); /* * pelco_GetCamCmdData() Get from Camera commands and datas with verify packet @@ -163,10 +225,9 @@ inline u_char pelco_GetCamNo(void * __restrict p); * @data[2] = Output Data for commands 1 & 2 * return: 'd' - PelcoD, 'p' - PelcoP, 0 - unknown or bad packet */ -inline u_char pelco_GetCamCmdData(void * __restrict p, u_char * __restrict cam, +u_char pelco_GetCamCmdData(void * __restrict p, u_char * __restrict cam, u_char * __restrict cmd, u_char * __restrict data); - /* * pelco_D_toCmd() Convert to Pelco D commands * @cmd[2] = Input Commands 1 & 2 @@ -174,7 +235,7 @@ inline u_char pelco_GetCamCmdData(void * __restrict p, * @cmd2 = Output typecasted commands 2 * return: 0xFF - error, !=0 return number arguments */ -inline u_char pelco_D_toCmd(u_char * __restrict cmd, +u_char pelco_D_toCmd(u_char * __restrict cmd, struct bitD_Cmd1 * __restrict cmd1, struct bitD_Cmd2 * __restrict cmd2); /* @@ -184,7 +245,7 @@ inline u_char pelco_D_toCmd(u_char * __restrict cmd, * @cmd2 = Output typecasted commands 2 * return: 0xFF - error, !=0 return number arguments */ -inline u_char pelco_P_toCmd(u_char * __restrict cmd, +u_char pelco_P_toCmd(u_char * __restrict cmd, struct bitP_Cmd1 * __restrict cmd1, struct bitP_Cmd2 * __restrict cmd2); /* @@ -194,7 +255,7 @@ inline u_char pelco_P_toCmd(u_char * __restrict cmd, * @cmd[2] = Output Commands 1 & 2 * return: 0xFF - error, 0 - ok */ -inline u_char pelco_D_fromCmd(struct bitD_Cmd1 cmd1, struct bitD_Cmd2 cmd2, +u_char pelco_D_fromCmd(struct bitD_Cmd1 cmd1, struct bitD_Cmd2 cmd2, u_char * __restrict cmd); /* @@ -204,7 +265,7 @@ inline u_char pelco_D_fromCmd(struct bitD_Cmd1 cmd1, s * @cmd[2] = Output Commands 1 & 2 * return: 0xFF - error, 0 - ok */ -inline u_char pelco_P_fromCmd(struct bitP_Cmd1 cmd1, struct bitP_Cmd2 cmd2, +u_char pelco_P_fromCmd(struct bitP_Cmd1 cmd1, struct bitP_Cmd2 cmd2, u_char * __restrict cmd); /* @@ -216,7 +277,7 @@ inline u_char pelco_P_fromCmd(struct bitP_Cmd1 cmd1, s * @p = Output Packet structure * return: 0xFF - error, 0 - ok */ -inline u_char pelco_SetCamCmdData(u_char ver, u_char __restrict cam, +u_char pelco_SetCamCmdData(u_char ver, u_char cam, u_char * __restrict cmd, u_char * __restrict data, void * __restrict p);