NanostackRfPhy.h

00001 /*
00002  * Copyright (c) 2016-2017, 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_RF_PHY_H_
00019 #define NANOSTACK_RF_PHY_H_
00020 
00021 #include "NanostackMACPhy.h"
00022 
00023 /** Radio PHY driver class for Nanostack */
00024 class NanostackRfPhy : public NanostackMACPhy {
00025 public:
00026 
00027     /** Return the default on-board NanostackRfPhy
00028      *
00029      * Returns the default on-board NanostackRfPhy - this will be target-specific, and
00030      * may not be available on all targets.
00031      */
00032     static NanostackRfPhy &get_default_instance();
00033 
00034     /** Register this physical interface with Nanostack
00035      *
00036      *  @return         Device driver ID or a negative error
00037      *                  code on failure
00038      */
00039     virtual int8_t rf_register() = 0;
00040 
00041     /** Unregister this physical interface
00042      *
00043      */
00044     virtual void rf_unregister() = 0;
00045 
00046     /** Register this physical interface with Nanostack
00047      *
00048      *  @return         Device driver ID or a negative error
00049      *                  code on failure
00050      */
00051     virtual int8_t phy_register()
00052     {
00053         return rf_register();
00054     }
00055 
00056     /** Unregister this physical interface
00057      *
00058      */
00059     virtual void unregister()
00060     {
00061         rf_unregister();
00062     }
00063 };
00064 
00065 #endif /* NANOSTACK_RF_PHY_H_ */