NanostackPhy.h

00001 /*
00002  * Copyright (c) 2016, 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_PHY_H_
00019 #define NANOSTACK_PHY_H_
00020 
00021 class NanostackMACPhy;
00022 class NanostackPPPPhy;
00023 
00024 /** PHY driver class for Nanostack */
00025 class NanostackPhy {
00026 public:
00027 
00028     /** Register this physical interface with Nanostack
00029      *
00030      *  @return         Device driver ID or a negative error
00031      *                  code on failure
00032      */
00033     virtual int8_t phy_register() = 0;
00034 
00035     /** Return pointer to a NanostackMACPhy.
00036      *
00037      *  @return         Pointer to requested phy type or NULL if this
00038      *                  class doesn't implement the phy.
00039      */
00040     virtual NanostackMACPhy *nanostack_mac_phy()
00041     {
00042         return 0;
00043     }
00044 
00045     /** Return pointer to a NanostackPPPPhy.
00046      *
00047      *  @return         Pointer to requested phy type or NULL if this
00048      *                  class doesn't implement the phy.
00049      */
00050     virtual NanostackPPPPhy *nanostack_ppp_phy()
00051     {
00052         return 0;
00053     }
00054 
00055 protected:
00056     NanostackPhy() {}
00057     virtual ~NanostackPhy() {}
00058 };
00059 
00060 #endif /* NANOSTACK_INTERFACE_H_ */