NanostackPPPPhy.h

00001 /*
00002  * Copyright (c) 2019, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef NANOSTACK_PPP_PHY_H_
00019 #define NANOSTACK_PPP_PHY_H_
00020 
00021 #include "NanostackPhy.h"
00022 /** PPP PHY driver class for Nanostack */
00023 class NanostackPPPPhy : public NanostackPhy {
00024 public:
00025     /** Link state callback function prototype
00026      *
00027      *  @param up       link up
00028      */
00029     typedef mbed::Callback<void (bool up)> link_state_change_cb_t;
00030 
00031     /** Set link state callback of this physical interface
00032      *
00033      *  @param cb       callback
00034      */
00035     virtual void set_link_state_change_cb(link_state_change_cb_t cb) = 0;
00036 
00037     /** Read the iid64 address of this physical interface
00038      *
00039      *  @param iid64    iid64 address
00040      */
00041     virtual void get_iid64(uint8_t *iid64) = 0;
00042 
00043     /** Read the mtu of this physical interface
00044      *
00045      * @return          mtu
00046      */
00047     virtual uint16_t get_mtu() = 0;
00048 
00049     /** Provide access to the NanostackMACPhy
00050      *
00051      * @return          NanostackPPPPhy
00052      */
00053     virtual NanostackPPPPhy *nanostack_ppp_phy()
00054     {
00055         return this;
00056     }
00057 };
00058 
00059 #endif /* NANOSTACK_PPP_PHY_H_ */