AirControlValve/User/protocol.h

/* Copyright Statement:
 *
 * This software/firmware and related documentation ("AutoChips Software") are
 * protected under relevant copyright laws. The information contained herein is
 * confidential and proprietary to AutoChips Inc. and/or its licensors. Without
 * the prior written permission of AutoChips inc. and/or its licensors, any
 * reproduction, modification, use or disclosure of AutoChips Software, and
 * information contained herein, in whole or in part, shall be strictly
 * prohibited.
 *
 * AutoChips Inc. (C) 2016. All rights reserved.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("AUTOCHIPS SOFTWARE")
 * RECEIVED FROM AUTOCHIPS AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
 * ON AN "AS-IS" BASIS ONLY. AUTOCHIPS EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES AUTOCHIPS PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH THE AUTOCHIPS SOFTWARE, AND RECEIVER AGREES
 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN AUTOCHIPS
 * SOFTWARE. AUTOCHIPS SHALL ALSO NOT BE RESPONSIBLE FOR ANY AUTOCHIPS SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND AUTOCHIPS'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE AUTOCHIPS SOFTWARE
 * RELEASED HEREUNDER WILL BE, AT AUTOCHIPS'S OPTION, TO REVISE OR REPLACE THE
 * AUTOCHIPS SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
 * CHARGE PAID BY RECEIVER TO AUTOCHIPS FOR SUCH AUTOCHIPS SOFTWARE AT ISSUE.
 */
 

#ifndef PROTOCOL_H
#define PROTOCOL_H

#ifdef __cplusplus
extern "C" {
#endif

#include "ac780x.h"

#define Cmd_FirmwareVersion    (0x0000)
#define Cmd_HardwareVersion    (0x0001)
#define Cmd_DeviceID    			 (0x0002)
#define Cmd_DeviceType    		 (0x0003)
#define Cmd_Reboot		 		     (0x0004)
#define Cmd_Reset    					 (0x0005)

#define Cmd_Addr    					 (0x0010)
#define Cmd_Baudrate    			 (0x0011)
#define Cmd_LockStatus    		 (0x0020)
//#define Cmd_FirmwareVersion    (0x0000)

#define Cmd_IapUpgrade    		 (0xAABB)

#define MODBUS_FUNC_READ				(0x03)
#define MODBUS_FUNC_WRITE				(0x06)

#define INVALID_FUNCTION_CODE   (0x01)
#define INVALID_COMMAND			    (0x02)
#define INVALID_DATA   					(0x03)
#define DEVICE_FAULT   					(0x04)



//读取时返回，数据长度, 如果返回 0， 说明buf_len 不够, 设备故障

uint16_t Read_FirmwareVersion(uint8_t *pBuf, uint16_t buf_len); 
uint16_t Read_HardwareVersion(uint8_t *pBuf, uint16_t buf_len); 
uint16_t Read_Deviceid(uint8_t *pBuf, uint16_t buf_len); 
uint16_t Read_Devicetype(uint8_t *pBuf, uint16_t buf_len); 
uint16_t Read_Addr(uint8_t *pBuf, uint16_t buf_len);
uint16_t Read_Baudrate(uint8_t *pBuf, uint16_t buf_len); 

uint16_t Read_LockStatus(uint8_t *pBuf, uint16_t buf_len);



#define RET_ERROR_MASK     (0xF0)
#define RET_OK  		 			(0x00)
#define RET_NEED_SAVE			(0X01)
#define RET_NEED_REBOOT		(0X02)

#define RET_DATAINVALID  	(0x10)
#define RET_CMDINVALID  	(0x20)
//#define RET_DATAINVALID  	(3)

//写入成功时返回 RET_OK
//写入不成功时，返回 RET_DATAINVALID
uint8_t Write_Addr(uint8_t *pdata, uint8_t len); 
uint8_t Write_Baudrate(uint8_t *pdata, uint8_t len);
uint8_t Write_HardwareVersion(uint8_t *pdata, uint8_t len); 
uint8_t Write_Deviceid(uint8_t *pdata, uint8_t len); 
uint8_t Write_Devicetype(uint8_t *pdata, uint8_t len); 
  
    
#ifdef __cplusplus
}
#endif

#endif /* PROTOCOL_H */