Branch data     Line data    Source code

       1                 :            : /* SPDX-License-Identifier: GPL-2.0 */
       2                 :            : #ifndef _ARM_HW_BREAKPOINT_H
       3                 :            : #define _ARM_HW_BREAKPOINT_H
       4                 :            : 
       5                 :            : #ifdef __KERNEL__
       6                 :            : 
       7                 :            : struct task_struct;
       8                 :            : 
       9                 :            : #ifdef CONFIG_HAVE_HW_BREAKPOINT
      10                 :            : 
      11                 :            : struct arch_hw_breakpoint_ctrl {
      12                 :            :                 u32 __reserved  : 9,
      13                 :            :                 mismatch        : 1,
      14                 :            :                                 : 9,
      15                 :            :                 len             : 8,
      16                 :            :                 type            : 2,
      17                 :            :                 privilege       : 2,
      18                 :            :                 enabled         : 1;
      19                 :            : };
      20                 :            : 
      21                 :            : struct arch_hw_breakpoint {
      22                 :            :         u32     address;
      23                 :            :         u32     trigger;
      24                 :            :         struct  arch_hw_breakpoint_ctrl step_ctrl;
      25                 :            :         struct  arch_hw_breakpoint_ctrl ctrl;
      26                 :            : };
      27                 :            : 
      28                 :            : static inline u32 encode_ctrl_reg(struct arch_hw_breakpoint_ctrl ctrl)
      29                 :            : {
      30                 :          0 :         return (ctrl.mismatch << 22) | (ctrl.len << 5) | (ctrl.type << 3) |
      31                 :          0 :                 (ctrl.privilege << 1) | ctrl.enabled;
      32                 :            : }
      33                 :            : 
      34                 :            : static inline void decode_ctrl_reg(u32 reg,
      35                 :            :                                    struct arch_hw_breakpoint_ctrl *ctrl)
      36                 :            : {
      37                 :          0 :         ctrl->enabled        = reg & 0x1;
      38                 :          0 :         reg >>= 1;
      39                 :          0 :         ctrl->privilege      = reg & 0x3;
      40                 :          0 :         reg >>= 2;
      41                 :          0 :         ctrl->type   = reg & 0x3;
      42                 :          0 :         reg >>= 2;
      43                 :          0 :         ctrl->len    = reg & 0xff;
      44                 :          0 :         reg >>= 17;
      45                 :          0 :         ctrl->mismatch       = reg & 0x1;
      46                 :            : }
      47                 :            : 
      48                 :            : /* Debug architecture numbers. */
      49                 :            : #define ARM_DEBUG_ARCH_RESERVED 0       /* In case of ptrace ABI updates. */
      50                 :            : #define ARM_DEBUG_ARCH_V6       1
      51                 :            : #define ARM_DEBUG_ARCH_V6_1     2
      52                 :            : #define ARM_DEBUG_ARCH_V7_ECP14 3
      53                 :            : #define ARM_DEBUG_ARCH_V7_MM    4
      54                 :            : #define ARM_DEBUG_ARCH_V7_1     5
      55                 :            : #define ARM_DEBUG_ARCH_V8       6
      56                 :            : 
      57                 :            : /* Breakpoint */
      58                 :            : #define ARM_BREAKPOINT_EXECUTE  0
      59                 :            : 
      60                 :            : /* Watchpoints */
      61                 :            : #define ARM_BREAKPOINT_LOAD     1
      62                 :            : #define ARM_BREAKPOINT_STORE    2
      63                 :            : #define ARM_FSR_ACCESS_MASK     (1 << 11)
      64                 :            : 
      65                 :            : /* Privilege Levels */
      66                 :            : #define ARM_BREAKPOINT_PRIV     1
      67                 :            : #define ARM_BREAKPOINT_USER     2
      68                 :            : 
      69                 :            : /* Lengths */
      70                 :            : #define ARM_BREAKPOINT_LEN_1    0x1
      71                 :            : #define ARM_BREAKPOINT_LEN_2    0x3
      72                 :            : #define ARM_BREAKPOINT_LEN_4    0xf
      73                 :            : #define ARM_BREAKPOINT_LEN_8    0xff
      74                 :            : 
      75                 :            : /* Limits */
      76                 :            : #define ARM_MAX_BRP             16
      77                 :            : #define ARM_MAX_WRP             16
      78                 :            : #define ARM_MAX_HBP_SLOTS       (ARM_MAX_BRP + ARM_MAX_WRP)
      79                 :            : 
      80                 :            : /* DSCR method of entry bits. */
      81                 :            : #define ARM_DSCR_MOE(x)                 ((x >> 2) & 0xf)
      82                 :            : #define ARM_ENTRY_BREAKPOINT            0x1
      83                 :            : #define ARM_ENTRY_ASYNC_WATCHPOINT      0x2
      84                 :            : #define ARM_ENTRY_SYNC_WATCHPOINT       0xa
      85                 :            : 
      86                 :            : /* DSCR monitor/halting bits. */
      87                 :            : #define ARM_DSCR_HDBGEN         (1 << 14)
      88                 :            : #define ARM_DSCR_MDBGEN         (1 << 15)
      89                 :            : 
      90                 :            : /* OSLSR os lock model bits */
      91                 :            : #define ARM_OSLSR_OSLM0         (1 << 0)
      92                 :            : 
      93                 :            : /* opcode2 numbers for the co-processor instructions. */
      94                 :            : #define ARM_OP2_BVR             4
      95                 :            : #define ARM_OP2_BCR             5
      96                 :            : #define ARM_OP2_WVR             6
      97                 :            : #define ARM_OP2_WCR             7
      98                 :            : 
      99                 :            : /* Base register numbers for the debug registers. */
     100                 :            : #define ARM_BASE_BVR            64
     101                 :            : #define ARM_BASE_BCR            80
     102                 :            : #define ARM_BASE_WVR            96
     103                 :            : #define ARM_BASE_WCR            112
     104                 :            : 
     105                 :            : /* Accessor macros for the debug registers. */
     106                 :            : #define ARM_DBG_READ(N, M, OP2, VAL) do {\
     107                 :            :         asm volatile("mrc p14, 0, %0, " #N "," #M ", " #OP2 : "=r" (VAL));\
     108                 :            : } while (0)
     109                 :            : 
     110                 :            : #define ARM_DBG_WRITE(N, M, OP2, VAL) do {\
     111                 :            :         asm volatile("mcr p14, 0, %0, " #N "," #M ", " #OP2 : : "r" (VAL));\
     112                 :            : } while (0)
     113                 :            : 
     114                 :            : struct perf_event_attr;
     115                 :            : struct notifier_block;
     116                 :            : struct perf_event;
     117                 :            : struct pmu;
     118                 :            : 
     119                 :            : extern int arch_bp_generic_fields(struct arch_hw_breakpoint_ctrl ctrl,
     120                 :            :                                   int *gen_len, int *gen_type);
     121                 :            : extern int arch_check_bp_in_kernelspace(struct arch_hw_breakpoint *hw);
     122                 :            : extern int hw_breakpoint_arch_parse(struct perf_event *bp,
     123                 :            :                                     const struct perf_event_attr *attr,
     124                 :            :                                     struct arch_hw_breakpoint *hw);
     125                 :            : extern int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
     126                 :            :                                            unsigned long val, void *data);
     127                 :            : 
     128                 :            : extern u8 arch_get_debug_arch(void);
     129                 :            : extern u8 arch_get_max_wp_len(void);
     130                 :            : extern void clear_ptrace_hw_breakpoint(struct task_struct *tsk);
     131                 :            : 
     132                 :            : int arch_install_hw_breakpoint(struct perf_event *bp);
     133                 :            : void arch_uninstall_hw_breakpoint(struct perf_event *bp);
     134                 :            : void hw_breakpoint_pmu_read(struct perf_event *bp);
     135                 :            : int hw_breakpoint_slots(int type);
     136                 :            : 
     137                 :            : #else
     138                 :            : static inline void clear_ptrace_hw_breakpoint(struct task_struct *tsk) {}
     139                 :            : 
     140                 :            : #endif  /* CONFIG_HAVE_HW_BREAKPOINT */
     141                 :            : #endif  /* __KERNEL__ */
     142                 :            : #endif  /* _ARM_HW_BREAKPOINT_H */