STRUCT SSH_PTL(9)

✨ NAME ✨

okay bestie, welcome to struct ssh_ptl(9) — the SSH packet transport layer from the Kernel API Manual. This is the whole struct tour, and we're gonna hit every field like it's a group chat roll call. 💅✨

🌸 SYNOPSIS 🌸

Here's the struct in all her glory, no edits, no cap:

struct ssh_ptl {
    struct serdev_device *serdev;
    unsigned long state;
    struct {
      spinlock_t lock;
      struct list_head head;
    } queue;
    struct {
      spinlock_t lock;
      struct list_head head;
      atomic_t count;
    } pending;
    struct {
      atomic_t running;
      struct task_struct *thread;
      struct completion thread_cplt_tx;
      struct completion thread_cplt_pkt;
      struct wait_queue_head packet_wq;
    } tx;
    struct {
      struct task_struct *thread;
      struct wait_queue_head wq;
      struct kfifo fifo;
      struct sshp_buf buf;
      struct {
        u16 seqs[8];
        u16 offset;
      } blocked;
    } rx;
    struct {
      spinlock_t lock;
      ktime_t timeout;
      ktime_t expires;
      struct delayed_work reaper;
    } rtx_timeout;
    struct ssh_ptl_ops ops;
};

🫶 Members 🫶

• serdev — struct serdev_device *: the serial device providing the underlying data transport. she's literally the plug. 🔌
• state — unsigned long: state(-flags) of the transport layer. 🚦
• queue — packet submission queue. 📬
  • queue.lock — spinlock_t: lock for modifying the packet submission queue.
  • queue.head — struct list_head: list-head of the packet submission queue.
• pending — set/list of pending packets. 🎟️
  • pending.lock — spinlock_t: lock for modifying the pending set.
  • pending.head — struct list_head: list-head of the pending set/list.
  • pending.count — atomic_t: number of currently pending packets.
• tx — transmitter subsystem. 📤
  • tx.running — atomic_t: flag indicating the (desired) transmitter thread state.
  • tx.thread — struct task_struct *: transmitter thread.
  • tx.thread_cplt_tx — struct completion: completion for transmitter thread waiting on transfer.
  • tx.thread_cplt_pkt — struct completion: completion for transmitter thread waiting on packets.
  • tx.packet_wq — struct wait_queue_head: waitqueue-head for packet transmit completion.
• rx — receiver subsystem. 📥
  • rx.thread — struct task_struct *: receiver thread.
  • rx.wq — struct wait_queue_head: waitqueue-head for receiver thread.
  • rx.fifo — struct kfifo: buffer for receiving data/pushing data to receiver thread.
  • rx.buf — struct sshp_buf: buffer for evaluating data on receiver thread.
  • rx.blocked — list of recent/blocked sequence IDs to detect retransmission. 🚫
    • rx.blocked.seqs — u16 seqs[8]: array of blocked sequence IDs.
    • rx.blocked.offset — u16 offset: offset indicating where a new ID should be inserted.
• rtx_timeout — retransmission timeout subsystem. ⏰
  • rtx_timeout.lock — spinlock_t: lock for modifying the retransmission timeout reaper.
  • rtx_timeout.timeout — ktime_t: timeout interval for retransmission.
  • rtx_timeout.expires — ktime_t: time specifying when the reaper work is next scheduled.
  • rtx_timeout.reaper — struct delayed_work: work performing timeout checks and subsequent actions.
• ops — struct ssh_ptl_ops: packet layer operations. 👑

🔮 SEE ALSO 🔮

• Kernel file ./drivers/platform/surface/aggregator/ssh_packet_layer.h
• enum ssh_ptl_state_flags(9)
• struct ssh_ptl_ops(9)
• ssh_ptl_get_device(9)
• ssh_ptl_tx_wakeup_transfer(9)

and that's the whole vibe, bestie — every member checked off, no cap. 💖 source/version: ./drivers/platform/surface/agg...; date: October 2026. struct ssh_ptl(9) signing off. 💅🎀