aboutsummaryrefslogtreecommitdiff
path: root/doc/opal-api/opal-lpc-read-write-67-68.rst
blob: 784147459e0837f3e7ec59c859a06e013f53c60f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
OPAL_LPC_READ
=============
::

  This function related to Low Pin Count (LPC) bus. This function reads the
  data from IDSEL register for ``chip_id``, which has LPC information.
  From ``addr`` for ``addr_type`` with read size ``sz`` bytes in to a
  variable named ``data``.

Parameters
----------

``chip_id``
  The ``chip_id`` parameter contains value of the chip number identified at
  boot time.

``addr_type``
  The ``addr_type`` is one of the LPC supported address types.
  Supported address types are -
  LPC memory,
  LPC IO and
  LPC firmware.

``addr``
  The ``addr`` from which the data has to be read.

``data``
  The ``data`` will be used to store the read data.

``sz``
   How many ``sz`` bytes to be read in to ``data``.

Return Codes
------------

``OPAL_PARAMETER``
   Indicates either ``chip_id`` not found or ``chip_id`` doesn’t contain
   LPC information.

``OPAL_SUCCESS``
  Indicates Success!

OPAL_LPC_WRITE
==============
::

  This function related to Low Pin Count (LPC) bus. This function writes the
  ``data`` in to  ECCB register for ``chip_id``, which has LPC information.
  From ``addr`` for ``addr_type`` with write size ``sz`` bytes.

Parameters
----------

``chip_id``
  The ``chip_id`` parameter contains value of the chip number identified at
  boot time.

``addr_type``
  The ``addr_type`` is one of the address types LPC supported.
  Supported address types are -
  LPC memory,
  LPC IO and
  LPC firmware.

``addr``
  The ``addr`` to where the ``data`` need to be written.

``data``
  The ``data`` for writing.

``sz``
   How many ``sz`` bytes to write.

Return Codes
------------

``OPAL_PARAMETER``
   Indicates either ``chip_id`` not found or ``chip_id`` doesn’t contain LPC
   information.

``OPAL_SUCCESS``
  Indicates Success!