xref: /linux/Documentation/netlink/specs/binder.yaml (revision 4f38da1f027ea2c9f01bb71daa7a299c191b6940)
163740349SLi Li# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
263740349SLi Li#
363740349SLi Li# Copyright 2025 Google LLC
463740349SLi Li#
563740349SLi Li---
663740349SLi Liname: binder
763740349SLi Liprotocol: genetlink
863740349SLi Liuapi-header: linux/android/binder_netlink.h
963740349SLi Lidoc: Binder interface over generic netlink
1063740349SLi Li
1163740349SLi Liattribute-sets:
1263740349SLi Li  -
1363740349SLi Li    name: report
1463740349SLi Li    doc: |
1563740349SLi Li      Attributes included within a transaction failure report. The elements
1663740349SLi Li      correspond directly with the specific transaction that failed, along
1763740349SLi Li      with the error returned to the sender e.g. BR_DEAD_REPLY.
1863740349SLi Li
1963740349SLi Li    attributes:
2063740349SLi Li      -
2163740349SLi Li        name: error
2263740349SLi Li        type: u32
2363740349SLi Li        doc: The enum binder_driver_return_protocol returned to the sender.
2463740349SLi Li      -
2563740349SLi Li        name: context
2663740349SLi Li        type: string
2763740349SLi Li        doc: The binder context where the transaction occurred.
2863740349SLi Li      -
29*73c94172SCarlos Llamas        name: from-pid
3063740349SLi Li        type: u32
3163740349SLi Li        doc: The PID of the sender process.
3263740349SLi Li      -
33*73c94172SCarlos Llamas        name: from-tid
3463740349SLi Li        type: u32
3563740349SLi Li        doc: The TID of the sender thread.
3663740349SLi Li      -
37*73c94172SCarlos Llamas        name: to-pid
3863740349SLi Li        type: u32
3963740349SLi Li        doc: |
4063740349SLi Li          The PID of the recipient process. This attribute may not be present
4163740349SLi Li          if the target could not be determined.
4263740349SLi Li      -
43*73c94172SCarlos Llamas        name: to-tid
4463740349SLi Li        type: u32
4563740349SLi Li        doc: |
4663740349SLi Li          The TID of the recipient thread. This attribute may not be present
4763740349SLi Li          if the target could not be determined.
4863740349SLi Li      -
49*73c94172SCarlos Llamas        name: is-reply
5063740349SLi Li        type: flag
5163740349SLi Li        doc: When present, indicates the failed transaction is a reply.
5263740349SLi Li      -
5363740349SLi Li        name: flags
5463740349SLi Li        type: u32
5563740349SLi Li        doc: The bitmask of enum transaction_flags from the transaction.
5663740349SLi Li      -
5763740349SLi Li        name: code
5863740349SLi Li        type: u32
5963740349SLi Li        doc: The application-defined code from the transaction.
6063740349SLi Li      -
61*73c94172SCarlos Llamas        name: data-size
6263740349SLi Li        type: u32
6363740349SLi Li        doc: The transaction payload size in bytes.
6463740349SLi Li
6563740349SLi Lioperations:
6663740349SLi Li  list:
6763740349SLi Li    -
6863740349SLi Li      name: report
6963740349SLi Li      doc: |
7063740349SLi Li        A multicast event sent to userspace subscribers to notify them about
7163740349SLi Li        binder transaction failures. The generated report provides the full
7263740349SLi Li        details of the specific transaction that failed. The intention is for
7363740349SLi Li        programs to monitor these events and react to the failures as needed.
7463740349SLi Li
7563740349SLi Li      attribute-set: report
7663740349SLi Li      mcgrp: report
7763740349SLi Li      event:
7863740349SLi Li        attributes:
7963740349SLi Li          - error
8063740349SLi Li          - context
81*73c94172SCarlos Llamas          - from-pid
82*73c94172SCarlos Llamas          - from-tid
83*73c94172SCarlos Llamas          - to-pid
84*73c94172SCarlos Llamas          - to-tid
85*73c94172SCarlos Llamas          - is-reply
8663740349SLi Li          - flags
8763740349SLi Li          - code
88*73c94172SCarlos Llamas          - data-size
8963740349SLi Li
9063740349SLi Limcast-groups:
9163740349SLi Li  list:
9263740349SLi Li    -
9363740349SLi Li      name: report
94