1 /*
2  *  Copyright (c) 2019, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes definitions for the spinel interface to Radio Co-processor (RCP)
32  *
33  */
34 
35 #ifndef POSIX_APP_SPINEL_INTERFACE_HPP_
36 #define POSIX_APP_SPINEL_INTERFACE_HPP_
37 
38 #include "lib/hdlc/hdlc.hpp"
39 #include "lib/spinel/spinel.h"
40 
41 namespace ot {
42 namespace Spinel {
43 
44 class SpinelInterface
45 {
46 public:
47     enum
48     {
49         kMaxFrameSize = OPENTHREAD_CONFIG_PLATFORM_RADIO_SPINEL_RX_FRAME_BUFFER_SIZE, ///< Maximum buffer size.
50     };
51 
52     /**
53      * This type defines a receive frame buffer to store received spinel frame(s).
54      *
55      * @note The receive frame buffer is an `Hdlc::MultiFrameBuffer` and therefore it is capable of storing multiple
56      * frames in a FIFO queue manner.
57      *
58      */
59     typedef Hdlc::MultiFrameBuffer<kMaxFrameSize> RxFrameBuffer;
60 
61     typedef void (*ReceiveFrameCallback)(void *aContext);
62 
63     /**
64      * This method indicates whether or not the frame is the Spinel SPINEL_CMD_RESET frame.
65      *
66      * @param[in] aFrame   A pointer to buffer containing the spinel frame.
67      * @param[in] aLength  The length (number of bytes) in the frame.
68      *
69      * @retval true  If the frame is a Spinel SPINEL_CMD_RESET frame.
70      * @retval false If the frame is not a Spinel SPINEL_CMD_RESET frame.
71      *
72      */
IsSpinelResetCommand(const uint8_t * aFrame,uint16_t aLength)73     static bool IsSpinelResetCommand(const uint8_t *aFrame, uint16_t aLength)
74     {
75         static constexpr uint8_t kSpinelResetCommand[] = {SPINEL_HEADER_FLAG | SPINEL_HEADER_IID_0, SPINEL_CMD_RESET};
76         return (aLength >= sizeof(kSpinelResetCommand)) &&
77                (memcmp(aFrame, kSpinelResetCommand, sizeof(kSpinelResetCommand)) == 0);
78     }
79 };
80 } // namespace Spinel
81 } // namespace ot
82 
83 #endif // POSIX_APP_SPINEL_INTERFACE_HPP_
84