esp_phy.h

Go to the documentation of this file.

/*
 Adapted from Arduino for Sming.
 Original copyright note is kept below.
 
 phy.c - ESP8266 PHY initialization data
 Copyright (c) 2015 Ivan Grokhotkov. All rights reserved.
 This file is part of the esp8266 core for Arduino environment.
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.
 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#include <esp_attr.h>
#include <sys/pgmspace.h>
#include <string.h>
 
struct PhyInitData {
    using txpwr_index_t = uint8_t;
 
    uint8_t* data; // [128]
 
    uint8_t get_version() const
    {
        return data[1];
    }
 
    void undocumented_26_29()
    {
    }
 
    void set_power_limits(txpwr_index_t chan1, txpwr_index_t chan11, txpwr_index_t chan13, txpwr_index_t chan14)
    {
        data[78] = 2; // Enable bytes 30-33 to set maximum TX power
        data[30] = chan1;
        data[31] = chan11;
        data[32] = chan13;
        data[33] = chan14;
    }
 
    void disable_power_limits()
    {
        data[78] = 0; // disable bytes 30-33
    }
 
    void set_txpwr_dqb(txpwr_index_t level, uint8_t value)
    {
        if(level < 6) {
            data[34 + level] = value;
        }
    }
 
    void set_txpwr(uint8_t mcs_index, txpwr_index_t txpwr_qdb)
    {
        if(mcs_index < 8 && txpwr_qdb < 6) {
            data[40 + mcs_index] = txpwr_qdb;
        }
    }
 
    void set_crystal_freq(uint8_t value = 1)
    {
        data[48] = value;
    }
 
    void set_sdio_configure(uint8_t value = 0)
    {
        data[50] = value;
    }
 
    void set_bt_configure(uint8_t value = 0)
    {
        data[51] = value;
    }
 
    void set_bt_protocol(uint8_t value = 0)
    {
        data[52] = value;
    }
 
    void set_dual_ant_configure(uint8_t value = 0)
    {
        data[53] = value;
    }
 
    void set_share_xtal(uint8_t value = 0)
    {
        data[55] = value;
    }
 
    void undocumented_64_73()
    {
    }
 
    void set_low_power_en(uint8_t value = 0)
    {
        data[93] = value;
    }
 
    void set_lp_rf_stg10(uint8_t value = 0)
    {
        data[94] = value;
    }
 
    void set_lp_bb_att_ext(uint8_t value = 0)
    {
        data[95] = value;
    }
 
    void set_default_power_limits_11b()
    {
        data[96] = 0;
    }
 
    void set_power_limits_11b(txpwr_index_t txpwr_index_11b_0, txpwr_index_t txpwr_index_11b_1)
    {
        data[96] = 1;
        data[97] = txpwr_index_11b_0;
        data[98] = txpwr_index_11b_1;
    }
 
    void set_vdd33_const(uint8_t value = 33)
    {
        data[107] = value;
    }
 
    void set_rf_cal_disable(uint8_t value = 0)
    {
        data[108] = value;
    }
 
    void set_freq_correct(uint8_t bbpll = 3, int8_t force_freq_offset = 0)
    {
        data[112] = bbpll;
        data[113] = uint8_t(force_freq_offset);
    }
 
    void set_rf_calibration(uint8_t value = 1)
    {
        data[114] = value;
    }
};
 
extern void customPhyInit(PhyInitData data);