components/openthread/openthread/src/lib/spinel/spinel_decoder.hpp (ESP-IDF)

Outline

#define SPINEL_DECODER_HPP_

#include "openthread-spinel-config.h"

#include <openthread/ip6.h>

#include <openthread/ncp.h>

#include "spinel.h"

Files

SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/openthread/openthread/src/lib/spinel/spinel_decoder.hpp

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

/* * Copyright (c) 2017, The OpenThread Authors. * 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. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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. */ /** * @file * This file contains the definitions of a spinel decoder. */ #ifndef SPINEL_DECODER_HPP_ #define SPINEL_DECODER_HPP_ #include "openthread-spinel-config.h" #include <openthread/ip6.h> #include <openthread/ncp.h> #include "spinel.h" namespace ot { namespace Spinel { /** * Defines a spinel decoder. */ class Decoder { public: enum { kMaxNestedStructs = 4, ///< Maximum number of nested structs. }; /** * Initializes a `Decoder` object. */ Decoder(void); /** * Initializes the decoder to start decoding a new frame. * * It sets the read position to the start of the frame and also erases/voids any saved positions (see * `SavePosition()` and `ResetToSaved()` methods). * * @param[in] aFrame Pointer to the buffer containing the frame to be decoded. * @param[in] aLength Length (number of bytes) of the frame. */ void Init(const uint8_t *aFrame, uint16_t aLength); /** * Returns the pointer to the start of the frame. * * @returns A pointer to buffer containing current frame being decoded. */ const uint8_t *GetFrame(void) const { return mFrame; } /** * Returns the total length of current frame being decoded. * * @returns The length of current frame being decoded. */ uint16_t GetLength(void) const { return mLength; } /** * Returns the number of bytes that are already read/decoded from the frame. * * @returns The number of bytes already read from frame. */ uint16_t GetReadLength(void) const { return mIndex; } /** * Returns the number of remaining (not yet read/decoded) bytes in the frame. * * @returns The number of remaining unread bytes in the frame. */ uint16_t GetRemainingLength(void) const { return mLength - mIndex; } /** * Indicates whether or not all the bytes in the frame are read. * * @returns TRUE if all the bytes in the buffer are read, FALSE otherwise. */ bool IsAllRead(void) const { return (mIndex == mLength); } /** * Resets the read position to beginning of frame. It will also void/erase any previously saved * position using `SavePosition()` method. */ void Reset(void); /** * Decodes and reads a boolean value form the frame. * * On success, the read position gets updated. * * @param[out] aBool Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aBool` is untouched. */ otError ReadBool(bool &aBool); /** * Decodes and reads an `int8_t` value form the frame. * * On success, the read position get updated. * * @param[out] aInt8 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aInt8` is untouched. */ otError ReadInt8(int8_t &aInt8); /** * Decodes and reads an `uint8_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aUint8 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUint8` is untouched. */ otError ReadUint8(uint8_t &aUint8); /** * Decodes and reads an `int16_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aInt16 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aInt16` is untouched. */ otError ReadInt16(int16_t &aInt16); /** * Decodes and reads an `uint16_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aUint16 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUint16` is untouched. */ otError ReadUint16(uint16_t &aUint16); /** * Decodes and reads an `int32_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aInt32 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `Int32` is untouched. */ otError ReadInt32(int32_t &aInt32); /** * Decodes and reads an `uint32_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aUint32 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUint32` is untouched. */ otError ReadUint32(uint32_t &aUint32); /** * Decodes and reads an `int64_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aInt64 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aInt64` is untouched. */ otError ReadInt64(int64_t &aInt64); /** * Decodes and reads an `uint64_t` value form the frame. * * On success, the read position gets updated. * * @param[out] aUint64 Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUint64` is untouched. */ otError ReadUint64(uint64_t &aUint64); /** * Decodes (using spinel packed integer format) and reads an unsigned integer value form the frame. * * On success, the read position gets updated. * * @param[out] aUint Reference to variable to output the read value. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUint` is untouched. */ otError ReadUintPacked(unsigned int &aUint); /** * Decodes and reads an IPv6 address form the frame. * * On success, the read position gets updated. * * @param[out] aIp6AddrPtr Reference to IPv6 address pointer to output the value (as `spinel_ipv6addr_t`). * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aIp6AddrPtr` is untouched. */ otError ReadIp6Address(const spinel_ipv6addr_t *&aIp6AddrPtr) { return ReadItem(reinterpret_cast<const uint8_t **>(&aIp6AddrPtr), sizeof(spinel_ipv6addr_t)); } /** * Decodes and reads an IPv6 address form the frame. * * On success, the read position gets updated. * * @param[out] aIp6AddrPtr Reference to IPv6 address pointer to output the value (as `otIp6Address`). * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aIp6AddrPtr` is untouched. */ otError ReadIp6Address(const otIp6Address *&aIp6AddrPtr) { return ReadItem(reinterpret_cast<const uint8_t **>(&aIp6AddrPtr), sizeof(spinel_ipv6addr_t)); } /** * Decodes and reads an IPv6 address form the frame. * * On success, the read position gets updated. * * @param[out] aIp6AddrBufPtr Reference to a buffer pointer to output the value. * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aIp6AddrBufPtr` is untouched. */ otError ReadIp6Address(const uint8_t *&aIp6AddrBufPtr) { return ReadItem(&aIp6AddrBufPtr, sizeof(spinel_ipv6addr_t)); } /** * Decodes and reads an IPv6 address form the frame. * * On success, the read position gets updated and the IP address is copied into the given output variable. * * @param[out] aIp6Addr Reference to IPv6 address variable to output the value (as `spinel_ipv6addr_t`). * On success, the address is copied into the output variable. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aIp6Addr` is untouched. */ otError ReadIp6Address(spinel_ipv6addr_t &aIp6Addr); /** * Decodes and reads an IPv6 address form the frame. * * On success, the read position gets updated and the IP address is copied into the given output variable. * * @param[out] aIp6Addr Reference to IPv6 address variable to output the value (as `otIp6Address`). * On success, the address is copied into the output variable. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aIp6Addr` is untouched. */ otError ReadIp6Address(otIp6Address &aIp6Addr); /** * Decodes and reads an EUI64 value form the frame. * * On success, the read position gets updated. * * @param[out] aEui64Ptr Reference to an EUI64 pointer to output the value (as `spinel_eui64_t`). * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui64Ptr` is untouched. */ otError ReadEui64(const spinel_eui64_t *&aEui64Ptr) { return ReadItem(reinterpret_cast<const uint8_t **>(&aEui64Ptr), sizeof(spinel_eui64_t)); } /** * Decodes and reads an EUI64 value form the frame. * * On success, the read position gets updated. * * @param[out] aEui64Ptr Reference to an EUI64 pointer to output the value (as `otExtAddress`). * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui64Ptr` is untouched. */ otError ReadEui64(const otExtAddress *&aEui64Ptr) { return ReadItem(reinterpret_cast<const uint8_t **>(&aEui64Ptr), sizeof(spinel_eui64_t)); } /** * Decodes and reads an EUI64 value form the frame. * * On success, the read position gets updated. * * @param[out] aEui64BufPtr Reference to a buffer pointer to output the value. * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui64BufPtr` is untouched. */ otError ReadEui64(const uint8_t *&aEui64BufPtr) { return ReadItem(&aEui64BufPtr, sizeof(spinel_eui64_t)); } /** * Decodes and reads an EUI64 value form the frame. * * On success, the read position gets updated and the EUI64 value is copied into the given output variable. * * @param[out] aEui64 Reference to EUI64 variable to output the value (as `spinel_eui64_t`). * On success, the address is copied into the output variable. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui64` is untouched. */ otError ReadEui64(spinel_eui64_t &aEui64); /** * Decodes and reads an EUI64 value form the frame. * * On success, the read position gets updated and the EUI64 value is copied into the given output variable. * * @param[out] aEui64 Reference to EUI64 variable to output the value (as `otExtAddress`). * On success, the address is copied into the output variable. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui64` is untouched. */ otError ReadEui64(otExtAddress &aEui64); /** * Decodes and reads an EUI48 value form the frame. * * On success, the read position gets updated. * * @param[out] aEui48Ptr Reference to an EUI48 pointer to output the value (as `spinel_eui48_t`). * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui48Ptr` is untouched. */ otError ReadEui48(const spinel_eui48_t *&aEui48Ptr) { return ReadItem(reinterpret_cast<const uint8_t **>(&aEui48Ptr), sizeof(spinel_eui48_t)); } /** * Decodes and reads an EUI48 value form the frame. * * On success, the read position gets updated. * * @param[out] aEui48BufPtr Reference to a buffer pointer to output the value. * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui48BufPtr` is untouched.. */ otError ReadEui48(const uint8_t *&aEui48BufPtr) { return ReadItem(&aEui48BufPtr, sizeof(spinel_eui48_t)); } /** * Decodes and reads an EUI48 value form the frame. * * On success, the read position gets updated and the EUI48 value is copied into the given output variable. * * @param[out] aEui48 Reference to EUI48 variable to output the value (as `spinel_eui48_t`). * On success, value is copied into the output variable. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aEui48` is untouched. */ otError ReadEui48(spinel_eui48_t &aEui48); /** * Decodes and reads a UTF8 string form the frame. * * On success, the read position gets updated. * * @param[out] aUtf8 Reference to a `char` pointer to output the string. * On success, the pointer variable is updated. * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value and `aUtf8` is untouched. */ otError ReadUtf8(const char *&aUtf8); /** * Decodes and reads a data blob (sequence of bytes) form the frame. * * On success, the read position gets updated. * * @param[out] aData Reference to pointer variable to output the data. * On success, the pointer variable is updated. * @param[out] aDataLen Reference to variable to output the data length (number of bytes). * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value. `aData` and `aDataLen` are untouched. */ otError ReadData(const uint8_t *&aData, uint16_t &aDataLen); /** * Decodes and reads a data blob (sequence of bytes) with data length. * * The data length is assumed to be prepended before the data content (encoded as a `uint16_t`). The size of the * length field should not be included in the length value. This method corresponds to `SPINEL_DATATYPE_DATA_WLEN` * type. * * @param[out] aData Reference to pointer variable to output the data. * On success, the pointer variable is updated. * @param[out] aDataLen Reference to variable to out the data length (number of bytes). * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value. `aDataLen` may be updated and `aData` is * untouched. */ otError ReadDataWithLen(const uint8_t *&aData, uint16_t &aDataLen); /** * Opens a struct in the frame. * * After a successful call to this method, all the subsequent `Read{SomeType}()` methods decode and read the * field/value from the current open struct until the struct is closed using `CloseStruct()` method. Structures can * be nested. Up to `kMaxNestedStructs` nested structs can be opened at the same time. * * @retval OT_ERROR_NONE Successfully opened a struct. * @retval OT_ERROR_PARSE Failed to parse/open a struct. * @retval OT_ERROR_INVALID_STATE Already at the maximum number of nested open structures. */ otError OpenStruct(void); /** * Closes the most recently opened struct (using `OpenStruct()`) in the frame. * * On success, the read position is moved to end of the struct skipping any unread bytes within the struct. * * @retval OT_ERROR_NONE Successfully closed the struct. * @retval OT_ERROR_INVALID_STATE There is no current open struct to close. */ otError CloseStruct(void); /** * Returns the number of remaining/unread bytes in the current inner-most open structure. * * If there is no currently open structure the number of remaining bytes in whole frame is returned instead. * * @returns The number of remaining unread bytes in the inner-most open structure. */ uint16_t GetRemainingLengthInStruct(void) const { return mEnd - mIndex; } /** * Indicates whether or not all the bytes in inner-most open structure are read. * * If there is no currently open structure, the whole frame is considered instead. * * @returns TRUE if all the bytes are read, FALSE otherwise. */ bool IsAllReadInStruct(void) const { return (mIndex == mEnd); } /** * Saves the current read position in the frame. * * A subsequent call to `SavePosition()` will overwrite the previously saved position. The saved position can be * used to move the read position back (using `ResetToSaved()`) and re-read the same content. * * Saved position can be within an open struct, and it remembers its enclosing struct. When the enclosing struct is * closed, the saved position will be voided and can no longer be used. This ensures that we cannot jump back to * middle an already fully decoded/read and closed struct. */ void SavePosition(void); /** * Resets/moves the read position to a previously saved position. * * The saved position remembers its enclosing structure. When `ResetToSaved()` is called, the current open * structure will be the same as when position was saved. * * @retval OT_ERROR_NONE Successfully reset the read position. * @retval OT_ERROR_INVALID_STATE The saved position is not valid (there is no saved position or the saved * position was voided since its enclosing struct was closed). */ otError ResetToSaved(void); private: otError ReadItem(const uint8_t **aPtr, uint16_t aSize); void ClearSavedPosition(void) { mSavedIndex = mLength; } bool IsSavedPositionValid(void) const { return (mSavedIndex < mLength); } const uint8_t *mFrame; // Frame buffer. uint16_t mLength; // Frame length (number of bytes). uint16_t mIndex; // Current read index. uint16_t mEnd; // Current end index (end of struct if in a struct, or end of buffer otherwise). uint8_t mNumOpenStructs; // Number of open structs. uint8_t mSavedNumOpenStructs; // Number of open structs when read position was saved. uint16_t mSavedIndex; // Read index when position was saved. uint16_t mSavedEnd; // End index when position was saved. uint16_t mPrevEnd[kMaxNestedStructs]; }; } // namespace Spinel } // namespace ot #endif // SPINEL_DECODER_HPP_

Details