lib/wlan/mlme/include/wlan/mlme/client/scanner.h

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GARNET_LIB_WLAN_MLME_INCLUDE_WLAN_MLME_CLIENT_SCANNER_H_
#define GARNET_LIB_WLAN_MLME_INCLUDE_WLAN_MLME_CLIENT_SCANNER_H_

#include <wlan/mlme/client/bss.h>
#include <wlan/mlme/client/channel_scheduler.h>

#include <fuchsia/wlan/mlme/cpp/fidl.h>

#include <fbl/unique_ptr.h>
#include <lib/zx/time.h>
#include <wlan/protocol/mac.h>
#include <zircon/types.h>

#include <unordered_map>

namespace wlan {

class Clock;
class DeviceInterface;
class Packet;
class Timer;
template <typename T> class MlmeMsg;

class Scanner {
   public:
    Scanner(DeviceInterface* device, ChannelScheduler* chan_sched);
    virtual ~Scanner() {}

    zx_status_t Start(const MlmeMsg<::fuchsia::wlan::mlme::ScanRequest>& req);
    void Reset();

    bool IsRunning() const;
    wlan_channel_t ScanChannel() const;

    zx_status_t HandleMlmeScanReq(const MlmeMsg<::fuchsia::wlan::mlme::ScanRequest>& req);
    void HandleBeacon(const MgmtFrameView<Beacon>& frame);
    void HandleHwScanAborted();
    void HandleHwScanComplete();

   private:
    struct OffChannelHandlerImpl : OffChannelHandler {
        Scanner* scanner_;

        explicit OffChannelHandlerImpl(Scanner* scanner) : scanner_(scanner) {}

        virtual void BeginOffChannelTime() override;
        virtual void HandleOffChannelFrame(fbl::unique_ptr<Packet>) override;
        virtual bool EndOffChannelTime(bool interrupted, OffChannelRequest* next_req) override;
    };

    zx_status_t StartHwScan();

    bool ShouldDropMgmtFrame(const MgmtFrameHeader& hdr);
    void ProcessBeacon(const MgmtFrameView<Beacon>& bcn_frame);
    OffChannelRequest CreateOffChannelRequest();
    void SendResultsAndReset();

    OffChannelHandlerImpl off_channel_handler_;
    DeviceInterface* device_;
    ::fuchsia::wlan::mlme::ScanRequestPtr req_ = nullptr;

    size_t channel_index_ = 0;

    std::unordered_map<uint64_t, Bss> current_bss_;
    ChannelScheduler* chan_sched_;
};

}  // namespace wlan

#endif  // GARNET_LIB_WLAN_MLME_INCLUDE_WLAN_MLME_CLIENT_SCANNER_H_