Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Normal
Revision Log

echonet_fbs.h@ 101

Last change on this file since 101 was 101, checked in by coas-nagasima, 9 years ago
TOPPERS/uKadecotのソースコードを追加
Property svn:eol-style set to `native` Property svn:keywords set to `Id` Property svn:mime-type set to `text/plain`
File size: 7.7 KB

Rev	Line
[101]	1	/*
	2	* TOPPERS ECHONET Lite Communication Middleware
	3	*
	4	* Copyright (C) 2014 Cores Co., Ltd. Japan
	5	*
	6	* ãLì ÒÍCÈºÌ(1)`(4)Ìðð½·êÉÀèC{\tgEF
	7	* Ai{\tgEFAðüÏµ½àÌðÜÞDÈº¯¶jðgpE¡»Eü
	8	* ÏEÄzziÈºCpÆÄÔj·é±Æð³Åø·éD
	9	* (1) {\tgEFAð\[XR[hÌ`Åp·éêÉÍCãLÌì
	10	* \¦C±Ìpð¨æÑºLÌ³ÛØKèªC»ÌÜÜÌ`Å\[
	11	* XR[hÉÜÜêÄ¢é±ÆD
	12	* (2) {\tgEFAðCCu`®ÈÇC¼Ì\tgEFAJÉg
	13	* pÅ«é`ÅÄzz·éêÉÍCÄzzÉº¤hL
	14	gip
	15	* Ò}j
	16	AÈÇjÉCãLÌì \¦C±Ìpð¨æÑºL
	17	* Ì³ÛØKèðfÚ·é±ÆD
	18	* (3) {\tgEFAðC@íÉgÝÞÈÇC¼Ì\tgEFAJÉg
	19	* pÅ«È¢`ÅÄzz·éêÉÍCÌ¢¸ê©Ìðð½·±
	20	* ÆD
	21	* (a) ÄzzÉº¤hL
	22	gipÒ}j
	23	AÈÇjÉCãLÌ
	24	* ì \¦C±Ìpð¨æÑºLÌ³ÛØKèðfÚ·é±ÆD
	25	* (b) ÄzzÌ`ÔðCÊÉèßéû@ÉæÁÄCTOPPERSvWFNgÉ
	26	* ñ·é±ÆD
	27	* (4) {\tgEFAÌpÉæè¼ÚIÜ½ÍÔÚIÉ¶¶é¢©Èé¹
	28	* Q©çàCãLì Ò¨æÑTOPPERSvWFNgðÆÓ·é±ÆD
	29	* Ü½C{\tgEFAÌ[UÜ½ÍGh[U©çÌ¢©Èé
	30	* RÉîÃ¿©çàCãLì Ò¨æÑTOPPERSvWFNgð
	31	* ÆÓ·é±ÆD
	32	*
	33	* {\tgEFAÍC³ÛØÅñ³êÄ¢éàÌÅ éDãLì Ò¨
	34	* æÑTOPPERSvWFNgÍC{\tgEFAÉÖµÄCÁèÌgpÚI
	35	* ÉÎ·éK«àÜßÄC¢©ÈéÛØàsíÈ¢DÜ½C{\tgEF
	36	* AÌpÉæè¼ÚIÜ½ÍÔÚIÉ¶¶½¢©Èé¹QÉÖµÄàC»
	37	* ÌÓCðíÈ¢D
	38	*
	39	* @(#) $Id: echonet_fbs.h 101 2015-06-02 15:37:23Z coas-nagasima $
	40	*/
	41
	42	/*
	43	* Åè·obt@ÂÏ·Xg[
	44	*/
	45
	46	#ifndef TOPPERS_ECHONET_FBS_H
	47	#define TOPPERS_ECHONET_FBS_H
	48
	49	#include <t_stddef.h>
	50	#include "echonet.h"
	51
	52	#ifdef __cplusplus
	53	extern "C" {
	54	#endif
	55
	56	#ifndef NUM_ECHONET_MEMPOOL_BLOCK
	57	#define NUM_ECHONET_MEMPOOL_BLOCK (60) /* d¶pubNÌ */
	58	#endif /* NUM_ECHONET_MEMPOOL_BLOCK */
	59
	60	#ifndef ECHONET_MEMPOOL_BLOCK_SIZE
	61	#define ECHONET_MEMPOOL_BLOCK_SIZE (256) /* d¶pubNÌTCY */
	62	#endif /* ECHONET_MEMPOOL_BLOCK_SIZE */
	63
	64	typedef unsigned int ECN_FBS_SIZE_T; /* size_t */
	65	typedef int ECN_FBS_SSIZE_T; /* ssize_t */
	66
	67	/* T_EDATAÇÌæTCY */
	68	#ifdef TARGET_KERNEL_ASP
	69	#define DEF_ECN_EDT_HDR_LEN (sizeof(T_MSG))
	70	#else
	71	#define DEF_ECN_EDT_HDR_LEN (sizeof(intptr_t))
	72	#endif
	73
	74	/* ÇÌæTCY(64byte - sizeof(T_MSG)) */
	75	/* #define DEF_ECN_FBS_LIB_HDR_LEN ((ECHONET_MEMPOOL_BLOCK_SIZE + sizeof(int) - 1)>> 2) // */
	76	#define DEF_ECN_FBS_LIB_HDR_LEN (64 - DEF_ECN_EDT_HDR_LEN)
	77
	78	/* ÇÌæðÜÞubNÉÛ·éf[^TCY */
	79	#define DEF_ECN_FBS_FST_DAT_LEN (64)
	80
	81	/* N\|C^zñÌTCY(byte) */
	82	#define DEF_ECN_FBS_LNK_LEN (ECHONET_MEMPOOL_BLOCK_SIZE - DEF_ECN_EDT_HDR_LEN - DEF_ECN_FBS_LIB_HDR_LEN - DEF_ECN_FBS_FST_DAT_LEN)
	83
	84	/* Åè·obt@ÅåTCY */
	85	#define DEF_ECN_FBS_BUF_MAXLEN ((DEF_ECN_FBS_LNK_LEN / sizeof(void )) ECHONET_MEMPOOL_BLOCK_SIZE + DEF_ECN_FBS_FST_DAT_LEN)
	86
	87	/* qvfobt@ÌTCY */
	88	#define DEF_ECN_FBS_SUB_BUF_LEN ECHONET_MEMPOOL_BLOCK_SIZE
	89
	90	/* d¶ÌíÊ(àeÍ¼) */
	91	typedef enum
	92	{
	93	ECN_FBS_TYPE_BLANK = 0, /* ¢gpXg[ */
	94	ECN_FBS_TYPE_INTERNAL = 1, /* àbZ[W */
	95	ECN_FBS_TYPE_ECHONET = 2 /* ECHONETd¶ */
	96	} TA_ECN_MSG_TYPE;
	97
	98	/* N\|C^zñÉñ³êéAqvfobt@ */
	99	typedef struct
	100	{
	101	uint8_t payload[ECHONET_MEMPOOL_BLOCK_SIZE];
	102	} T_ECN_SUB_BLK;
	103
	104	/* N\|C^zñ */
	105	typedef union
	106	{
	107	T_ECN_SUB_BLK p_sub[DEF_ECN_FBS_LNK_LEN / sizeof(T_ECN_SUB_BLK )];
	108	uint8_t bin[DEF_ECN_FBS_LNK_LEN];
	109	} T_ECN_FBS_LNK;
	110
	111	/* ÇÌæ(64byte - sizeof(T_MSG)) */
	112	typedef struct
	113	{
	114	uint16_t length; /* bZ[W· */
	115	uint16_t type; /* bZ[W^Cv */
	116	union{
	117	ECN_ENOD_ID sender; /* M³m[hIDiECHONETd¶j */
	118	ID sender_mbxid; /* M³[{bNXIDiàbZ[Wj */
	119	};
	120	union{
	121	ECN_ENOD_ID target; /* Mæm[hIDiECHONETd¶j */
	122	ID target_mbxid; /* Mæ[{bNXIDiàbZ[Wj */
	123	};
	124	union{
	125	ECN_ENOD_ID reply; /* ÔMæm[hIDiECHONETd¶j */
	126	ID reply_mbxid; /* ÔMæ[{bNXIDiàbZ[Wj */
	127	};
	128
	129	int rd; /* ÇÝæèwbhîñ */
	130	int wr; /* «Ýwbhîñ */
	131	} T_ECN_FBS_HDR;
	132
	133	/* ÇÌæðÜÞubNÌ\¢ */
	134	typedef struct
	135	{
	136	uint8_t _msg[DEF_ECN_EDT_HDR_LEN]; /* T_MSG */
	137	T_ECN_FBS_HDR hdr; /* ÇÌæ 64byte - sizeof(T_MSG) */
	138	uint8_t _gap[DEF_ECN_FBS_LIB_HDR_LEN - sizeof(T_ECN_FBS_HDR)];
	139	T_ECN_FBS_LNK lnk; /* N\|C^zñ 128byte */
	140	uint8_t payload[DEF_ECN_FBS_FST_DAT_LEN];
	141	} T_ECN_FST_BLK;
	142
	143	/* FBS-ID */
	144	typedef struct ecn_fbs_id_strc
	145	{
	146	T_ECN_FST_BLK *ptr;
	147	} ECN_FBS_ID;
	148
	149	/* bZ[WL
	150	[ */
	151	typedef struct ecn_fbs_queue
	152	{
	153	T_ECN_FST_BLK pk_head; / æªÌbZ[W */
	154	T_ECN_FST_BLK pk_last; / öÌbZ[W */
	155	} T_ECN_FBS_QUEUE;
	156
	157	/* ubNæ¾ ok:\|C^ NG:NULL */
	158	void *_ecn_fbs_mbx_get(ECN_FBS_SIZE_T fa_req_size);
	159
	160	/* ubNðú ok:0 NG:ñ0 */
	161	ER _ecn_fbs_mbx_rel(void *p);
	162
	163	/*
	164	* ÌæmÛ
	165	* ø
	166	* ECN_FBS_SIZE_T fa_req_size vobt@TCY(byte)
	167	* max: DEF_ECN_FBS_BUF_MAXLEN
	168	* ECN_FBS_ID *fp_id mÛµ½FBS-IDÌi[æ
	169	* ßèl
	170	* ER 0:ok ñ0:NG
	171	*/
	172	ER _ecn_fbs_cre(ECN_FBS_SIZE_T fa_req_size, ECN_FBS_ID *fp_id);
	173
	174	/*
	175	* Ìæðú
	176	* ø
	177	* ecn_fbs_id^ mÛµ½FBS-ID
	178	* ßèl
	179	* ER 0:ok, ñ0:NG
	180	*/
	181	ER _ecn_fbs_del(ECN_FBS_ID fa_id);
	182
	183	/*
	184	* Ûf[^ÌL³
	185	* ø
	186	* ecn_fbs_id^ mÛµ½FBS-ID
	187	* ßèl
	188	* bool_t 0:³µ, 1: è
	189	*/
	190	bool_t _ecn_fbs_exist_data(ECN_FBS_ID fa_id);
	191
	192	/*
	193	* Ûf[^·Ìæ¾
	194	* ø
	195	* ecn_fbs_id^ mÛµ½FBS-ID
	196	* ßèl
	197	* ECN_FBS_SSIZE_T ÛµÄ¢éf[^Ì·³(byte) -1:NG
	198	*/
	199	ECN_FBS_SSIZE_T _ecn_fbs_get_datalen(ECN_FBS_ID fa_id);
	200
	201	/*
	202	* ÇÝæèJ[\ÌÊuæ¾
	203	* ø
	204	* ecn_fbs_id^ mÛµ½FBS-ID
	205	* ßèl
	206	* ECN_FBS_SIZE_T æª©çÌâÎÊu -1:NG
	207	*/
	208	ECN_FBS_SSIZE_T _ecn_fbs_get_rpos(ECN_FBS_ID fa_id);
	209
	210	/*
	211	* ÇÝæèJ[\ÌÊuÝè
	212	* ø
	213	* ecn_fbs_id^ mÛµ½FBS-ID
	214	* ECN_FBS_SIZE_T fa_pos Ýè·éÊu(æª©çÌâÎÊu)
	215	* ßèl
	216	* ER 0:ok, ñ0:NG
	217	*/
	218	ER _ecn_fbs_set_rpos(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_pos);
	219
	220	/*
	221	* ÇÝæèJ[\ÌÊuÚ®
	222	* ø
	223	* ecn_fbs_id^ mÛµ½FBS-ID
	224	* ECN_FBS_SIZE_T fa_seek Ú®Ê(»óAOiÌÝ)
	225	* ßèl
	226	* ER 0:ok, ñ0:NG
	227	*/
	228	ER _ecn_fbs_seek_rpos(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek);
	229
	230	/*
	231	* CÓwèÊuÌ1byteÇÝæè
	232	*/
	233	int _ecn_fbs_peek(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek);
	234
	235	/*
	236	* CÓwèÊuÌ1byte«Ý
	237	*/
	238	ER _ecn_fbs_poke(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek, int fa_val);
	239
	240	/*
	241	* f[^ÇÁ
	242	* ø
	243	* ecn_fbs_id^ mÛµ½FBS-ID
	244	* const void * fa_dat ÇÁ·éf[^
	245	* ECN_FBS_SSIZE_T fa_len ÇÁ·é·³(byte)
	246	* ßèl
	247	* ER 0:ok, ñ0:NG
	248	*/
	249	ER _ecn_fbs_add_data(ECN_FBS_ID fa_id, const void *fa_dat, ECN_FBS_SSIZE_T fa_len);
	250
	251	/*
	252	* f[^ÇÁ(Ìæð©®IÉg£·é)
	253	* ø
	254	* ecn_fbs_id^ mÛµ½FBS-ID
	255	* const void * fa_dat ÇÁ·éf[^
	256	* ECN_FBS_SSIZE_T fa_len ÇÁ·é·³(byte)
	257	* ßèl
	258	* ER 0:ok, ñ0:NG
	259	*/
	260	ER _ecn_fbs_add_data_ex(ECN_FBS_ID fa_id, const void *fa_dat, ECN_FBS_SSIZE_T fa_len);
	261
	262	/*
	263	* f[^æ¾
	264	* ø
	265	* ecn_fbs_id^ mÛµ½FBS-ID
	266	* void * fa_buf æ¾·éobt@
	267	* ECN_FBS_SSIZE_T fa_maxlen æ¾·é·³(byte)
	268	* ECN_FBS_SSIZE_T *p_len æ¾µ½·³(byte)
	269	* ßèl
	270	* ER 0:ok, ñ0:NG
	271	*/
	272	ER _ecn_fbs_get_data(ECN_FBS_ID fa_id, void *fa_buf, ECN_FBS_SSIZE_T fa_maxlen,
	273	ECN_FBS_SSIZE_T *p_len);
	274
	275	ER ecn_fbs_enqueue(T_ECN_FBS_QUEUE pk_queue, T_ECN_FST_BLK pk_buf);
	276	ER ecn_fbs_dequeue(T_ECN_FBS_QUEUE pk_queue, T_ECN_FST_BLK *ppk_buf);
	277
	278	#ifdef __cplusplus
	279	} /* extern "C" */
	280	#endif
	281
	282	#endif /* #ifndef TOPPERS_ECHONET_FBS_H */

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format