one-key-cpufriend_cn.sh

#!/bin/bash

#set -x # for DEBUGGING

# stevezhengshiqi 创建于2019年2月8日。
# 暂时只支持大部分5代-8代U, 更老的CPU不使用X86PlatformPlugin.kext。
# 此脚本很依赖于 CPUFriend(https://github.com/acidanthera/CPUFriend), 感谢PMHeart。

# 当前的board-id
BOARD_ID="$(ioreg -lw0 | grep -i "board-id" | sed -e '/[^<]*</s///; s/\"//g; s/\>//; s/\>>//')"

# 输出样式设置
BOLD="\033[1m"
RED="\033[1;31m"
GREEN="\033[1;32m"
OFF="\033[m"

# Cloudflare 链接
CFURL="https://hackintosh.stevezheng.workers.dev"

# 对应的plist
X86_PLIST="/System/Library/Extensions/IOPlatformPluginFamily.kext/Contents/PlugIns/X86PlatformPlugin.kext/Contents/Resources/${BOARD_ID}.plist"

# 支持的型号
EPP_SUPPORTED_MODELS=(
  'Mac-9AE82516C7C6B903' # MacBook9,1
  'Mac-EE2EBD4B90B839A8' # MacBook10,1
  'Mac-827FAC58A8FDFA22' # MacBookAir8,1
  'Mac-226CB3C6A851A671' # MacBookAir8,2
  'Mac-473D31EABEB93F9B' # MacBookPro13,1
  'Mac-66E35819EE2D0D05' # MacBookPro13,2
  'Mac-A5C67F76ED83108C' # MacBookPro13,3
  'Mac-B4831CEBD52A0C4C' # MacBookPro14,1
  'Mac-CAD6701F7CEA0921' # MacBookPro14,2
  'Mac-551B86E5744E2388' # MacBookPro14,3
  'Mac-937A206F2EE63C01' # MacBookPro15,1
  'Mac-827FB448E656EC26' # MacBookPro15,2
  'Mac-1E7E29AD0135F9BC' # MacBookPro15,3
  'Mac-53FDB3D8DB8CA971' # MacBookPro15,4
  'Mac-E1008331FDC96864' # MacBookPro16,1
  'Mac-E7203C0F68AA0004' # MacBookPro16,3
  'Mac-A61BADE1FDAD7B05' # MacBookPro16,4
)

EPP_SUPPORTED_MODELS_SPECIAL=(
'Mac-7BA5B2DFE22DDD8C' # Macmini8,1
)

LFM_SUPPORTED_MODELS=(
  'Mac-BE0E8AC46FE800CC' # MacBook8,1
  'Mac-9F18E312C5C2BF0B' # MacBookAir7,1
  'Mac-937CB26E2E02BB01' # MacBookAir7,2
  'Mac-E43C1C25D4880AD6' # MacBookPro12,1
  'Mac-A369DDC4E67F1C45' # iMac16,1
  'Mac-FFE5EF870D7BA81A' # iMac16,2
  'Mac-4B682C642B45593E' # iMac18,1
  'Mac-77F17D7DA9285301' # iMac18,2
  'Mac-AA95B1DDAB278B95' # iMac19,1
  'Mac-63001698E7A34814' # iMac19,2
  'Mac-CFF7D910A743CAAF' # iMac20,1
  'Mac-AF89B6D9451A490B' # iMac20,2
)

LFM_800_MODELS=(
  'Mac-0CFF9C7C2B63DF8D' # MacBookAir9,1
  'Mac-5F9802EFE386AA28' # MacBookPro16,2
)

function init() {
  if [[ ${OSTYPE} != darwin* ]]; then
    echo "此脚本只能在 macOS 上运行，正在退出"
    exit 1
  fi
}

function printHeader() {
  printf '\e[8;40;90t'

  # 界面 (参考: http://patorjk.com/software/taag/#p=display&f=Ivrit&t=C%20P%20U%20F%20R%20I%20E%20N%20D)
  echo '  ____   ____    _   _   _____   ____    ___   _____   _   _   ____ '
  echo ' / ___| |  _ \  | | | | |  ___| |  _ \  |_ _| | ____| | \ | | |  _ \ '
  echo '| |     | |_) | | | | | | |_    | |_) |  | |  |  _|   |  \| | | | | | '
  echo '| |___  |  __/  | |_| | |  _|   |  _ <   | |  | |___  | |\  | | |_| | '
  echo ' \____| |_|      \___/  |_|     |_| \_\ |___| |_____| |_| \_| |____/ '
  echo
  echo "你的board-id是 ${BOARD_ID}"
  echo '====================================================================='
}

# 检查board-id
function checkBoardID() {
  if echo "${EPP_SUPPORTED_MODELS[@]}" | grep -w "${BOARD_ID}" &> /dev/null; then
    support=2
  elif echo "${EPP_SUPPORTED_MODELS_SPECIAL[@]}" | grep -w "${BOARD_ID}" &> /dev/null; then
    support=3
  elif echo "${LFM_800_MODELS[@]}" | grep -w "${BOARD_ID}" &> /dev/null; then
    support=4
  elif echo "${LFM_SUPPORTED_MODELS[@]}" | grep -w "${BOARD_ID}" &> /dev/null; then
    support=1
  else
    echo -e "[ ${RED}ERROR${OFF} ]: 抱歉，你的board-id暂不被支持!"
    exit 1
  fi
}

# 如果网络异常，退出
function networkWarn() {
  echo -e "[ ${RED}ERROR${OFF} ]: 下载CPUFriend失败, 请检查网络状态!"
  clean
  exit 1
}

# 下载CPUFriend仓库并解压最新release
function downloadKext() {
  local cfURL
  local HG
  local rcURL

  # 新建工程文件夹
  WORK_DIR="$HOME/Desktop/one-key-cpufriend"
  [[ -d "${WORK_DIR}" ]] && sudo rm -rf "${WORK_DIR}"
  mkdir -p "${WORK_DIR}" && cd "${WORK_DIR}" || exit 1

  echo
  echo '----------------------------------------------------------------------'
  echo '|* 正在下载CPUFriend，源自github.com/acidanthera/CPUFriend @PMHeart *|'
  echo '----------------------------------------------------------------------'

  # 下载ResourceConverter.sh
  rcURL="${CFURL}/https://raw.githubusercontent.com/acidanthera/CPUFriend/master/Tools/ResourceConverter.sh"
  curl --silent -L -O "${rcURL}" || networkWarn
  chmod +x ./ResourceConverter.sh || exit 1

  # 下载CPUFriend.kext
  HG="grep -m 1 RELEASE"
  cfRawURL="https://github.com/acidanthera/CPUFriend/releases/latest"
  cfRawURL=$(curl -Ls -o /dev/null -w "%{url_effective}" "${cfRawURL}" | sed 's/releases\/tag/releases\/expanded_assets/')
  cfURL="${CFURL}/https://github.com$(curl -L --silent "${cfRawURL}" | grep '/download/' | eval "${HG}" | sed 's/^[^"]*"\([^"]*\)".*/\1/')"
  if [[ -z ${cfURL} || ${cfURL} == "https://github.com" ]]; then
    networkWarn
  fi
  # GitHub的CDN是被Amazon所拥有, 所以我们在这添加 -L 来支持重置链接
  curl -# -L -O "${cfURL}" || networkWarn
  # 解压
  unzip -qq "*.zip" || exit 1
  echo -e "[ ${GREEN}OK${OFF} ]下载完成"
}

# 拷贝目标plist
function copyPlist() {
  if [[ ! -f "${X86_PLIST}" ]]; then
    echo -e "[ ${RED}ERROR${OFF} ]: 未找到${X86_PLIST}!"
    clean
    exit 1
  fi

  cp "${X86_PLIST}" . || exit 1
}

# 修改LFM值来调整最低频率
# 重新考虑这个方法是否必要, 因为LFM看起来不会影响性能表现
function changeLFM(){
  echo
  echo "------------------------------"
  echo "|****** 选择低频率模式 ******|"
  echo "------------------------------"
  if [ "${support}" == 4 ]; then
    echo "(1) 1200mhz"
    echo "(2) 800mhz (保持不变)"
  else
    echo "(1) 1200/1300mhz (保持不变)"
    echo "(2) 800mhz (低负载下更省电)"
  fi
  echo "(3) 自定义"
  echo -e "${BOLD}你想选择哪个选项? (1/2/3)${OFF}"
  read -rp ":" lfm_selection
  case ${lfm_selection} in
    1)
    # 处理 LFM_800_MODELS
    # 把 800 改成 1200
    if [ "${support}" == 4 ]; then
      # 修改 0200000008000000 成 020000000c000000
      /usr/bin/sed -i "" "s:AgAAAAgAAAA:AgAAAAwAAAA:g" "$BOARD_ID.plist"
    fi
    ;;

    2)
    # 把 1200/1300 改成 800
    if [ "${support}" != 4 ]; then
      # 修改 020000000d000000 成 0200000008000000
      /usr/bin/sed -i "" "s:AgAAAA0AAAA:AgAAAAgAAAA:g" "$BOARD_ID.plist"

      # 修改 020000000c000000 成 0200000008000000
      /usr/bin/sed -i "" "s:AgAAAAwAAAA:AgAAAAgAAAA:g" "$BOARD_ID.plist"
    fi
    ;;

    3)
    # 自定义LFM
    customizeLFM
    ;;

    *)
    echo -e "[ ${RED}ERROR${OFF} ]: 输入有误, 脚本将退出"
    clean
    exit 1
    ;;
  esac
}

# 自定义LFM
function customizeLFM
{
  local Count=0
  local gLFM_RAW=""

  # 检查循环次数和输入值
  while  [ ${Count} -lt 3 ] && [[ ${gLFM_RAW} != 0 ]];
  do
    echo
    echo -e "${BOLD}请输入最低频率, 单位是mhz (例如 1300, 2700), 输入0来退出${OFF}"
    echo "有效值应该在800和3500之间, 离谱的值可能会导致硬件故障!"
    read -rp ": " gLFM_RAW
    if [ "${gLFM_RAW}" == 0 ]; then
      # 如果用户输入0, 回到主程序
      return

    # 检查gLFM_RAW是否为整数
    elif [[ ${gLFM_RAW} =~ ^[0-9]*$ ]]; then

      # 可接受的LFM应该在400~4000之间
      if [ "${gLFM_RAW}" -ge 400 ] && [ "${gLFM_RAW}" -le 4000 ]; then
        # 从输入值获取4位十进制数字, 例如 800 -> 0800
        gLFM_RAW=$(printf '%04d' "${gLFM_RAW}")
        # 提取开头两位数字
        gLFM_RAW=$(echo "${gLFM_RAW}" | cut -c -2)
        # 移除开头的0, 因为比如08, bash会判断它为八进制数字
        gLFM_RAW=$(echo "${gLFM_RAW}" | sed 's/0*//')
        # 转换gLFM_RAW到十六进制, 并把它插入到LFM字段
        gLFM_VAL=$(printf '02000000%02x000000' "${gLFM_RAW}")
        # 转换gLFM_VAL到base64
        gLFM_ENCODE=$(echo "${gLFM_VAL}" | xxd -r -p | base64)
        # 提取开头11位数字
        gLFM_ENCODE=$(echo "${gLFM_ENCODE}" | cut -c -11)

        if [ "${support}" == 4 ]; then
          # 修改 0200000008000000 成 02000000{自定义值}000000
          /usr/bin/sed -i "" "s:AgAAAAgAAAA:${gLFM_ENCODE}:g" "$BOARD_ID.plist"
        else
          # 修改 020000000d000000 成 02000000{自定义值}000000
          /usr/bin/sed -i "" "s:AgAAAA0AAAA:${gLFM_ENCODE}:g" "$BOARD_ID.plist"
          # 修改 020000000c000000 成 02000000{自定义值}000000
          /usr/bin/sed -i "" "s:AgAAAAwAAAA:${gLFM_ENCODE}:g" "$BOARD_ID.plist"
        fi
        return

      else
        # 非有效值, 给3次机会重新输入
        echo
        echo -e "[ ${BOLD}WARNING${OFF} ]: 请输入有效值 (400~4000)!"
        Count=$((Count+1))
      fi

    else
      # 非有效值, 给3次机会重新输入
      echo
      echo -e "[ ${BOLD}WARNING${OFF} ]: 请输入有效值 (400~4000)!"
      Count=$((Count+1))
    fi
  done

  if [ ${Count} -gt 2 ]; then
    # 如果3次机会后输入值仍然非有效值, 退出
    echo -e "[ ${RED}ERROR${OFF} ]: 输入有误, 脚本将退出"
    clean
    exit 1
  fi
}

# 修改EPP值来调节性能模式 (参考: https://www.tonymacx86.com/threads/skylake-hwp-enable.214915/page-7)
# TO DO: 用更好的方式来修改变频参数, 见 https://github.com/Piker-Alpha/freqVectorsEdit.sh
function changeEPP(){
  echo
  echo "----------------------------"
  echo "|****** 选择性能模式 ******|"
  echo "----------------------------"
  echo "(1) 最省电模式"

  # 处理EPP_SUPPORTED_MODELS_SPECIAL
  if [ "${support}" == 2 ] || [ "${support}" == 4 ]; then
    echo "(2) 平衡电量模式 (默认)"
    echo "(3) 平衡性能模式"
  elif [ "${support}" == 3 ]; then
    echo "(2) 平衡电量模式"
    echo "(3) 平衡性能模式 (默认)"
  fi

  echo "(4) 高性能模式"
  echo -e "${BOLD}你想选择哪个模式? (1/2/3/4)${OFF}"
  read -rp ":" epp_selection
  case ${epp_selection} in
    1)
    # 把 80/90/92 改成 C0, 最省电模式

    # 修改 657070000000000000000000000000000000000080 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAc:DAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000080 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAd:DAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000092 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:CSAAAAAAAAAAAAAAAAAAAAc:DAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000090 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:CQAAAAAAAAAAAAAAAAAAAAc:DAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000092 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACS:ZXBwAAAAAAAAAAAAAAAAAAAAAADA:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000080 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACA:ZXBwAAAAAAAAAAAAAAAAAAAAAADA:g" "$BOARD_ID.plist"
    
    # 修改 657070000000000000000000000000000000000090 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACQ:ZXBwAAAAAAAAAAAAAAAAAAAAAADA:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000020 成 6570700000000000000000000000000000000000c0
    /usr/bin/sed -i "" "s:AgAAAAAAAAAAAAAAAAAAAAd:DAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"
    ;;

    2)
    if { [ "${support}" == 2 ] && [ "${lfm_selection}" == 1 ]; } || { [ "${support}" == 4 ] && [ "${lfm_selection}" == 2 ]; }; then
      # 保持默认值 80/90/92, 平衡电量模式
      # 如果LFM也没有改变, 退出脚本
      echo "不忘初心，方得始终。下次再见。"
      clean
      exit 0

    # 处理 EPP_SUPPORTED_MODELS_SPECIAL
    elif [ "${support}" == 3 ]; then
      # 把 20 改成 80, 平衡电量模式

      # 修改 657070000000000000000000000000000000000020 成 657070000000000000000000000000000000000080
      /usr/bin/sed -i "" "s:AgAAAAAAAAAAAAAAAAAAAAd:CAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"
    fi
    ;;

    3)
    if [ "${support}" == 2 ] || [ "${support}" == 4 ]; then
      # 把 80/90/92 改成 40, 平衡性能模式

      # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAc:BAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

      # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAd:BAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"

      # 修改 657070000000000000000000000000000000000092 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:CSAAAAAAAAAAAAAAAAAAAAc:BAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

      # 修改 657070000000000000000000000000000000000090 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:CQAAAAAAAAAAAAAAAAAAAAc:BAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

      # 修改 657070000000000000000000000000000000000092 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACS:ZXBwAAAAAAAAAAAAAAAAAAAAAABA:g" "$BOARD_ID.plist"

      # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACA:ZXBwAAAAAAAAAAAAAAAAAAAAAABA:g" "$BOARD_ID.plist"
      
      # 修改 657070000000000000000000000000000000000090 成 657070000000000000000000000000000000000040
      /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACQ:ZXBwAAAAAAAAAAAAAAAAAAAAAABA:g" "$BOARD_ID.plist"

    elif [ "${support}" == 3 ] && [ "${lfm_selection}" == 1 ]; then
      # 保持默认值 20, 平衡性能模式
      # 如果LFM也没有改变, 退出脚本
      echo "不忘初心，方得始终。下次再见。"
      clean
      exit 0
    fi
    ;;

    4)
    # 把 80/90/92 改成 00, 高性能模式

    # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAc:AAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:CAAAAAAAAAAAAAAAAAAAAAd:AAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000092 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:CSAAAAAAAAAAAAAAAAAAAAc:AAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000090 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:CQAAAAAAAAAAAAAAAAAAAAc:AAAAAAAAAAAAAAAAAAAAAAc:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000092 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACS:ZXBwAAAAAAAAAAAAAAAAAAAAAAAA:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000080 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACA:ZXBwAAAAAAAAAAAAAAAAAAAAAAAA:g" "$BOARD_ID.plist"
    
    # 修改 657070000000000000000000000000000000000090 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:ZXBwAAAAAAAAAAAAAAAAAAAAAACQ:ZXBwAAAAAAAAAAAAAAAAAAAAAAAA:g" "$BOARD_ID.plist"

    # 修改 657070000000000000000000000000000000000020 成 657070000000000000000000000000000000000000
    /usr/bin/sed -i "" "s:AgAAAAAAAAAAAAAAAAAAAAd:AAAAAAAAAAAAAAAAAAAAAAd:g" "$BOARD_ID.plist"
    ;;

    *)
    echo -e "[ ${RED}ERROR${OFF} ]: 输入有误, 脚本将退出"
    clean
    exit 1
    ;;
  esac
}

# 生成 CPUFriendDataProvider.kext 并复制到桌面
function generateKext(){
  echo
  echo "正在生成CPUFriendDataProvider.kext"
  ./ResourceConverter.sh --kext "$BOARD_ID.plist" || exit 1
  cp -r CPUFriendDataProvider.kext "$HOME/Desktop/" || exit 1

  # 拷贝CPUFriend.kext到桌面
  cp -r CPUFriend.kext "$HOME/Desktop/" || exit 1

  echo -e "[ ${GREEN}OK${OFF} ]生成完成"
}

# 清理临时文件夹文件夹并结束
function clean(){
  echo
  echo "正在清理临时文件"
  sudo rm -rf "${WORK_DIR}"
  echo -e "[ ${GREEN}OK${OFF} ]清理完成"
  echo
}

# 主程序
function main(){
  init
  printHeader
  checkBoardID
  downloadKext
  if [ "${support}" == 1 ]; then
    copyPlist
    changeLFM
  elif [ "${support}" == 2 ] || [ "${support}" == 3 ] || [ "${support}" == 4 ]; then
    copyPlist
    changeLFM
    changeEPP
  fi
  generateKext
  clean
  echo -e "[ ${GREEN}OK${OFF} ]脚本运行结束, 请把桌面上的 CPUFriend 和 CPUFriendDataProvider"
  echo "Clover: 放入 /CLOVER/kexts/Other/ 或者 L/E/ 路径下"
  echo "OC: 放入 /OC/Kexts/ 并添加 README_CN 中的补丁到 config.plist - Kernel - Add"
  exit 0
}

main