[164] | 1 | /*
|
---|
| 2 | * TOPPERS ECHONET Lite Communication Middleware
|
---|
| 3 | *
|
---|
| 4 | * Copyright (C) 2014-2016 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 164 2016-03-07 11:33:50Z 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 <kernel.h>
|
---|
| 50 | #include "echonet.h"
|
---|
| 51 |
|
---|
| 52 | #ifdef __cplusplus
|
---|
| 53 | extern "C" {
|
---|
| 54 | #endif
|
---|
| 55 |
|
---|
| 56 | #ifndef ECHONET_MEMPOOL_GET_TMO
|
---|
| 57 | #define ECHONET_MEMPOOL_GET_TMO (0) /* v[æ¾Ì^CAEgwè */
|
---|
| 58 | #endif /* ECHONET_MEMPOOL_GET_TMO */
|
---|
| 59 |
|
---|
| 60 | #ifndef NUM_ECHONET_MEMPOOL_BLOCK
|
---|
| 61 | #define NUM_ECHONET_MEMPOOL_BLOCK (60) /* d¶pubNÌ */
|
---|
| 62 | #endif /* NUM_ECHONET_MEMPOOL_BLOCK */
|
---|
| 63 |
|
---|
| 64 | #ifndef ECHONET_MEMPOOL_BLOCK_SIZE
|
---|
| 65 | #define ECHONET_MEMPOOL_BLOCK_SIZE (256) /* d¶pubNÌTCY */
|
---|
| 66 | #endif /* ECHONET_MEMPOOL_BLOCK_SIZE */
|
---|
| 67 |
|
---|
| 68 | typedef unsigned int ECN_FBS_SIZE_T; /* size_t */
|
---|
| 69 | typedef int ECN_FBS_SSIZE_T; /* ssize_t */
|
---|
| 70 |
|
---|
| 71 | /* T_EDATAÇÌæTCY */
|
---|
| 72 | #ifdef TARGET_KERNEL_ASP
|
---|
| 73 | #define DEF_ECN_EDT_HDR_LEN (sizeof(T_MSG))
|
---|
| 74 | #else
|
---|
| 75 | #define DEF_ECN_EDT_HDR_LEN (sizeof(intptr_t))
|
---|
| 76 | #endif
|
---|
| 77 |
|
---|
| 78 | /* ÇÌæTCY(64byte - sizeof(T_MSG)) */
|
---|
| 79 | /* #define DEF_ECN_FBS_LIB_HDR_LEN ((ECHONET_MEMPOOL_BLOCK_SIZE + sizeof(int) - 1)>> 2) // */
|
---|
| 80 | #define DEF_ECN_FBS_LIB_HDR_LEN (64 - DEF_ECN_EDT_HDR_LEN)
|
---|
| 81 |
|
---|
| 82 | /* ÇÌæðÜÞubNÉÛ·éf[^TCY */
|
---|
| 83 | #define DEF_ECN_FBS_FST_DAT_LEN (64)
|
---|
| 84 |
|
---|
| 85 | /* N|C^zñÌTCY(byte) */
|
---|
| 86 | #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)
|
---|
| 87 |
|
---|
| 88 | /* Åè·obt@ÅåTCY */
|
---|
| 89 | #define DEF_ECN_FBS_BUF_MAXLEN ((DEF_ECN_FBS_LNK_LEN / sizeof(void *)) * ECHONET_MEMPOOL_BLOCK_SIZE + DEF_ECN_FBS_FST_DAT_LEN)
|
---|
| 90 |
|
---|
| 91 | /* qvfobt@ÌTCY */
|
---|
| 92 | #define DEF_ECN_FBS_SUB_BUF_LEN ECHONET_MEMPOOL_BLOCK_SIZE
|
---|
| 93 |
|
---|
| 94 | /* d¶ÌíÊ(àeͼ) */
|
---|
| 95 | typedef enum
|
---|
| 96 | {
|
---|
| 97 | ECN_FBS_TYPE_BLANK = 0, /* ¢gpXg[ */
|
---|
| 98 | ECN_FBS_TYPE_INTERNAL = 1, /* àbZ[W */
|
---|
| 99 | ECN_FBS_TYPE_ECHONET = 2 /* ECHONETd¶ */
|
---|
| 100 | } TA_ECN_MSG_TYPE;
|
---|
| 101 |
|
---|
| 102 | /* N|C^zñÉñ³êéAqvfobt@ */
|
---|
| 103 | typedef struct
|
---|
| 104 | {
|
---|
| 105 | uint8_t payload[ECHONET_MEMPOOL_BLOCK_SIZE];
|
---|
| 106 | } T_ECN_SUB_BLK;
|
---|
| 107 |
|
---|
| 108 | /* N|C^zñ */
|
---|
| 109 | typedef union
|
---|
| 110 | {
|
---|
| 111 | T_ECN_SUB_BLK *p_sub[DEF_ECN_FBS_LNK_LEN / sizeof(T_ECN_SUB_BLK *)];
|
---|
| 112 | uint8_t bin[DEF_ECN_FBS_LNK_LEN];
|
---|
| 113 | } T_ECN_FBS_LNK;
|
---|
| 114 |
|
---|
| 115 | /* ÇÌæ(64byte - sizeof(T_MSG)) */
|
---|
| 116 | typedef struct
|
---|
| 117 | {
|
---|
| 118 | uint16_t length; /* bZ[W· */
|
---|
| 119 | uint16_t type; /* bZ[W^Cv */
|
---|
| 120 | union{
|
---|
| 121 | ECN_ENOD_ID id; /* M³m[hIDiECHONETd¶j */
|
---|
| 122 | ID mbxid; /* M³[{bNXIDiàbZ[Wj */
|
---|
| 123 | }sender;
|
---|
| 124 | union{
|
---|
| 125 | ECN_ENOD_ID id; /* Mæm[hIDiECHONETd¶j */
|
---|
| 126 | ID mbxid; /* Mæ[{bNXIDiàbZ[Wj */
|
---|
| 127 | }target;
|
---|
| 128 | union{
|
---|
| 129 | ECN_ENOD_ID id; /* ÔMæm[hIDiECHONETd¶j */
|
---|
| 130 | ID mbxid; /* ÔMæ[{bNXIDiàbZ[Wj */
|
---|
| 131 | }reply;
|
---|
| 132 |
|
---|
| 133 | int rd; /* ÇÝæèwbhîñ */
|
---|
| 134 | int wr; /* «Ýwbhîñ */
|
---|
| 135 | } T_ECN_FBS_HDR;
|
---|
| 136 |
|
---|
| 137 | /* ÇÌæðÜÞubNÌ\¢ */
|
---|
| 138 | typedef struct
|
---|
| 139 | {
|
---|
| 140 | uint8_t _msg[DEF_ECN_EDT_HDR_LEN]; /* T_MSG */
|
---|
| 141 | T_ECN_FBS_HDR hdr; /* ÇÌæ 64byte - sizeof(T_MSG) */
|
---|
| 142 | uint8_t _gap[DEF_ECN_FBS_LIB_HDR_LEN - sizeof(T_ECN_FBS_HDR)];
|
---|
| 143 | T_ECN_FBS_LNK lnk; /* N|C^zñ 128byte */
|
---|
| 144 | uint8_t payload[DEF_ECN_FBS_FST_DAT_LEN];
|
---|
| 145 | } T_ECN_FST_BLK;
|
---|
| 146 |
|
---|
| 147 | /* FBS-ID */
|
---|
| 148 | typedef struct ecn_fbs_id_strc
|
---|
| 149 | {
|
---|
| 150 | T_ECN_FST_BLK *ptr;
|
---|
| 151 | } ECN_FBS_ID;
|
---|
| 152 |
|
---|
| 153 | /* bZ[WL
|
---|
| 154 | [ */
|
---|
| 155 | typedef struct ecn_fbs_queue
|
---|
| 156 | {
|
---|
| 157 | T_ECN_FST_BLK *pk_head; /* æªÌbZ[W */
|
---|
| 158 | T_ECN_FST_BLK *pk_last; /* öÌbZ[W */
|
---|
| 159 | } T_ECN_FBS_QUEUE;
|
---|
| 160 |
|
---|
| 161 | /*
|
---|
| 162 | * ÌæmÛ
|
---|
| 163 | * ø
|
---|
| 164 | * ECN_FBS_SIZE_T fa_req_size vobt@TCY(byte)
|
---|
| 165 | * max: DEF_ECN_FBS_BUF_MAXLEN
|
---|
| 166 | * ECN_FBS_ID *fp_id mÛµ½FBS-IDÌi[æ
|
---|
| 167 | * ßèl
|
---|
| 168 | * ER 0:ok ñ0:NG
|
---|
| 169 | */
|
---|
| 170 | ER _ecn_fbs_cre(ECN_FBS_SIZE_T fa_req_size, ECN_FBS_ID *fp_id);
|
---|
| 171 |
|
---|
| 172 | /*
|
---|
| 173 | * Ìæðú
|
---|
| 174 | * ø
|
---|
| 175 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 176 | * ßèl
|
---|
| 177 | * ER 0:ok, ñ0:NG
|
---|
| 178 | */
|
---|
| 179 | ER _ecn_fbs_del(ECN_FBS_ID fa_id);
|
---|
| 180 |
|
---|
| 181 | /*
|
---|
| 182 | * Ûf[^ÌL³
|
---|
| 183 | * ø
|
---|
| 184 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 185 | * ßèl
|
---|
| 186 | * bool_t 0:³µ, 1: è
|
---|
| 187 | */
|
---|
| 188 | bool_t _ecn_fbs_exist_data(ECN_FBS_ID fa_id);
|
---|
| 189 |
|
---|
| 190 | /*
|
---|
| 191 | * Ûf[^·Ìæ¾
|
---|
| 192 | * ø
|
---|
| 193 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 194 | * ßèl
|
---|
| 195 | * ECN_FBS_SSIZE_T ۵Ģéf[^Ì·³(byte) -1:NG
|
---|
| 196 | */
|
---|
| 197 | ECN_FBS_SSIZE_T _ecn_fbs_get_datalen(ECN_FBS_ID fa_id);
|
---|
| 198 |
|
---|
| 199 | /*
|
---|
| 200 | * ÇÝæèJ[\ÌÊuæ¾
|
---|
| 201 | * ø
|
---|
| 202 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 203 | * ßèl
|
---|
| 204 | * ECN_FBS_SIZE_T 檩çÌâÎÊu -1:NG
|
---|
| 205 | */
|
---|
| 206 | ECN_FBS_SSIZE_T _ecn_fbs_get_rpos(ECN_FBS_ID fa_id);
|
---|
| 207 |
|
---|
| 208 | /*
|
---|
| 209 | * ÇÝæèJ[\ÌÊuÝè
|
---|
| 210 | * ø
|
---|
| 211 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 212 | * ECN_FBS_SIZE_T fa_pos Ýè·éÊu(檩çÌâÎÊu)
|
---|
| 213 | * ßèl
|
---|
| 214 | * ER 0:ok, ñ0:NG
|
---|
| 215 | */
|
---|
| 216 | ER _ecn_fbs_set_rpos(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_pos);
|
---|
| 217 |
|
---|
| 218 | /*
|
---|
| 219 | * ÇÝæèJ[\ÌÊuÚ®
|
---|
| 220 | * ø
|
---|
| 221 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 222 | * ECN_FBS_SIZE_T fa_seek Ú®Ê(»óAOiÌÝ)
|
---|
| 223 | * ßèl
|
---|
| 224 | * ER 0:ok, ñ0:NG
|
---|
| 225 | */
|
---|
| 226 | ER _ecn_fbs_seek_rpos(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek);
|
---|
| 227 |
|
---|
| 228 | /*
|
---|
| 229 | * CÓwèÊuÌ1byteÇÝæè
|
---|
| 230 | */
|
---|
| 231 | int _ecn_fbs_peek(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek);
|
---|
| 232 |
|
---|
| 233 | /*
|
---|
| 234 | * CÓwèÊuÌ1byte«Ý
|
---|
| 235 | */
|
---|
| 236 | ER _ecn_fbs_poke(ECN_FBS_ID fa_id, ECN_FBS_SSIZE_T fa_seek, int fa_val);
|
---|
| 237 |
|
---|
| 238 | /*
|
---|
| 239 | * f[^ÇÁ
|
---|
| 240 | * ø
|
---|
| 241 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 242 | * const void * fa_dat ÇÁ·éf[^
|
---|
| 243 | * ECN_FBS_SSIZE_T fa_len ÇÁ·é·³(byte)
|
---|
| 244 | * ßèl
|
---|
| 245 | * ER 0:ok, ñ0:NG
|
---|
| 246 | */
|
---|
| 247 | ER _ecn_fbs_add_data(ECN_FBS_ID fa_id, const void *fa_dat, ECN_FBS_SSIZE_T fa_len);
|
---|
| 248 |
|
---|
| 249 | /*
|
---|
| 250 | * f[^ÇÁ(Ìæð©®IÉg£·é)
|
---|
| 251 | * ø
|
---|
| 252 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 253 | * const void * fa_dat ÇÁ·éf[^
|
---|
| 254 | * ECN_FBS_SSIZE_T fa_len ÇÁ·é·³(byte)
|
---|
| 255 | * ßèl
|
---|
| 256 | * ER 0:ok, ñ0:NG
|
---|
| 257 | */
|
---|
| 258 | ER _ecn_fbs_add_data_ex(ECN_FBS_ID fa_id, const void *fa_dat, ECN_FBS_SSIZE_T fa_len);
|
---|
| 259 |
|
---|
| 260 | /*
|
---|
| 261 | * f[^æ¾
|
---|
| 262 | * ø
|
---|
| 263 | * ecn_fbs_id^ mÛµ½FBS-ID
|
---|
| 264 | * void * fa_buf æ¾·éobt@
|
---|
| 265 | * ECN_FBS_SSIZE_T fa_maxlen æ¾·é·³(byte)
|
---|
| 266 | * ECN_FBS_SSIZE_T *p_len æ¾µ½·³(byte)
|
---|
| 267 | * ßèl
|
---|
| 268 | * ER 0:ok, ñ0:NG
|
---|
| 269 | */
|
---|
| 270 | ER _ecn_fbs_get_data(ECN_FBS_ID fa_id, void *fa_buf, ECN_FBS_SSIZE_T fa_maxlen,
|
---|
| 271 | ECN_FBS_SSIZE_T *p_len);
|
---|
| 272 |
|
---|
| 273 | ER ecn_fbs_enqueue(T_ECN_FBS_QUEUE *pk_queue, T_ECN_FST_BLK *pk_buf);
|
---|
| 274 | ER ecn_fbs_dequeue(T_ECN_FBS_QUEUE *pk_queue, T_ECN_FST_BLK **ppk_buf);
|
---|
| 275 |
|
---|
| 276 | #ifdef __cplusplus
|
---|
| 277 | } /* extern "C" */
|
---|
| 278 | #endif
|
---|
| 279 |
|
---|
| 280 | #endif /* #ifndef TOPPERS_ECHONET_FBS_H */
|
---|