Coverage for hdl_registers/generator/python/register_accessor_interface.py: 100%

1# -------------------------------------------------------------------------------------------------- 

2# Copyright (c) Lukas Vik. All rights reserved. 

3# 

4# This file is part of the hdl-registers project, an HDL register generator fast enough to run 

5# in real time. 

6# https://hdl-registers.com 

7# https://github.com/hdl-registers/hdl-registers 

8# -------------------------------------------------------------------------------------------------- 

9 

10from abc import ABC, abstractmethod 

11 

12 

13class PythonRegisterAccessorInterface(ABC): 

14 """ 

15 Interface base class for accessing register values on a target system. 

16 To be used with code generated by :class:`.PythonAccessorGenerator`. 

17 See the :ref:`Python generator documentation <generator_python>` for usage details. 

18 

19 In order to use :class:`.PythonAccessorGenerator` class to read/write/print register and 

20 field values, you must implement the methods of this interface in a subclass. 

21 You must implement them to use whichever method you have available 

22 to access register values on your target (SSH, telnet, UART, ...). 

23 These details vary greatly in different projects, and is something that hdl-registers 

24 can not provide a generic solution for. 

25 

26 The byte address that shall be accessed, in both the methods, is 

27 

28 register_list_base_address + register_address 

29 

30 where ``register_list_base_address`` is the the base address of the requested register 

31 list on your register bus. 

32 Logic for finding this base address, probably using ``register_list_name``, must be 

33 implemented given the layout of your system. 

34 

35 You are free to raise any exceptions you want in your implementation of the methods. 

36 For example, unknown register list name, invalid address, timeout, bus error, etc. 

37 Exceptions will not be caught by :class:`.PythonAccessorGenerator` code, 

38 but will instead be propagated to the user wherever the accessor is used. 

39 """ 

40 

41 @abstractmethod 

42 def read_register(self, register_list_name: str, register_address: int) -> int: 

43 """ 

44 Read the value of a register. 

45 

46 Arguments: 

47 register_list_name: Name of the register list that the requested register belongs to. 

48 register_address: Byte address of the register, within the register list. 

49 

50 Return: 

51 The register value that was read, as an unsigned 32-bit number. 

52 """ 

53 

54 @abstractmethod 

55 def write_register( 

56 self, register_list_name: str, register_address: int, register_value: int 

57 ) -> None: 

58 """ 

59 Write a register. 

60 

61 Arguments: 

62 register_list_name: Name of the register list that the requested register belongs to. 

63 register_address: Byte address of the register, within the register list. 

64 register_value: The value that shall be written, as an unsigned 32-bit number. 

65 """