ucsicontrol(1)

📦 version 0.6.0, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💅 ucsicontrol(1) — the girlies' guide to UCSI connectors ✨

okay so bestie, welcome to ucsicontrol, part of the libtypec docs 🫶 she lists UCSI connector details and honestly? she ate.

✨ NAME ✨

ucsicontrol — list UCSI connector details 💖

🎀 SYNOPSIS 🎀

ucsicontrol [OPTIONS]

no positional args, no drama, just vibes and options 💅

🌸 OPTIONS 🌸

  • --help, -h — show the usage message. the "help me bestie" button 🥺
  • --conn_rst conn_num soft|hard — do a reset on the connector. you gotta say which kind: soft or hard. pick your fighter ✨
  • --get_cap — get capabilities 👑
  • --get_conn_cap conn_num — get Connector Capability
  • --get_conn_sts conn_num — get Connector Status
  • --get_cable_prop conn_num — get Cable Properties 🧵
  • --get_cur_cam conn_num — get Current Alternate mode
  • --get_alt_mode conn_num recipient — get Alternate Modes
    • recipient: 0: connector, 1: SOP, 2: SOP', 3: SOP'' ⭐
  • --get_pdos conn_num partner offset src_snk type — get PDOs from local and partner Policy Managers (both of them, she's thorough 💜)
    • partner: set to 1 to retrieve partner PDOs
    • offset: starting offset of the first PDO to be returned, 0 to 7
    • src_snk: set to 1 to retrieve source PDOs, 0 to retrieve sink PDOs
    • type: type of PDOs to retrieve (0: current supported, 1: advertised, 2: maximum supported)
  • --set_uor conn_num DFP|UFP|Accept — set the USB operation role for the connector to operate at. heads up: if the connector does not have an active connection, this command has no effect 🙈
    • DFP: Downstream Facing Port
    • UFP: Upstream Facing Port
    • Accept: accept role swap change requests from the port partner 🤝
  • --set_pdr conn_num SRC|SNK|Accept — set the Power direction that the OPM wants the connector to operate at. also heads up: if the connector does not have an active connection, or the partner is not PD-capable, this command has no effect 💀
    • SRC: Source role
    • SNK: Sink role
    • Accept: accept power swap change requests from the port partner 🤝

💀 BUGS 💀

not me telling you this but… error handling while parsing command-line arguments is poor. like, lowkey expect a crash when you don't pass all the required arguments 😭 fr fr, give her everything she asks for.

bestie please pass every required argument. she WILL fall over. no cap. 🫠

👑 AUTHORS 👑

Madhu M <madhu.m@intel.com>, Rajaram Regupathy <rajaram.regupathy@gmail.com>

written by the libtypec girlies, doc'd under the ucsicontrol(1) banner — that's a wrap, slay, periodt ✨🎀💖

📦 where this page comes from