[Skiboot] [PATCH 073/110] Remove never implemented OPAL_PCI_SET_PHB_TABLE_MEMORY and document why

[Andrew Donnellan]

On 31/5/19 4:13 pm, Stewart Smith wrote:
> Not ever used by upstream linux or PowerKVM tree. Never implemented in
> skiboot (not even in ancient internal only tree).
> 
> So, it's incredibly safe to remove.
> 
> Signed-off-by: Stewart Smith <stewart at linux.ibm.com>

Reviewed-by: Andrew Donnellan <ajd at linux.ibm.com>

> ---
>   core/pci-opal.c        | 12 ------------
>   doc/opal-api/index.rst | 13 ++++++++++++-
>   include/opal-api.h     |  2 +-
>   3 files changed, 13 insertions(+), 14 deletions(-)
> 
> diff --git a/core/pci-opal.c b/core/pci-opal.c
> index b0e61b639f39..9b8d4000490b 100644
> --- a/core/pci-opal.c
> +++ b/core/pci-opal.c
> @@ -246,18 +246,6 @@ static int64_t opal_pci_map_pe_mmio_window(uint64_t phb_id, uint64_t pe_number,
>   }
>   opal_call(OPAL_PCI_MAP_PE_MMIO_WINDOW, opal_pci_map_pe_mmio_window, 5);
>   
> -static int64_t opal_pci_set_phb_table_memory(uint64_t phb_id __unused,
> -					     uint64_t rtt_addr __unused,
> -					     uint64_t ivt_addr __unused,
> -					     uint64_t ivt_len __unused,
> -					     uint64_t rej_array_addr __unused,
> -					     uint64_t peltv_addr __unused)
> -{
> -	/* IODA2 (P8) stuff, TODO */
> -	return OPAL_UNSUPPORTED;
> -}
> -opal_call(OPAL_PCI_SET_PHB_TABLE_MEMORY, opal_pci_set_phb_table_memory, 6);
> -
>   static int64_t opal_pci_set_pe(uint64_t phb_id, uint64_t pe_number,
>   			       uint64_t bus_dev_func, uint8_t bus_compare,
>   			       uint8_t dev_compare, uint8_t func_compare,
> diff --git a/doc/opal-api/index.rst b/doc/opal-api/index.rst
> index aa775b5fe712..6e7a8a16869f 100644
> --- a/doc/opal-api/index.rst
> +++ b/doc/opal-api/index.rst
> @@ -78,7 +78,8 @@ The OPAL API is the interface between an Operating System and OPAL.
>   +---------------------------------------------+--------------+------------------------+----------+-----------------+
>   | :ref:`OPAL_PCI_MAP_PE_MMIO_WINDOW`          |  29          | v1.0 (Initial Release) | POWER8   |                 |
>   +---------------------------------------------+--------------+------------------------+----------+-----------------+
> -| :ref:`OPAL_PCI_SET_PHB_TABLE_MEMORY`        |  30          | v1.0 (Initial Release) | POWER8   |                 |
> +| :ref:`OPAL_PCI_SET_PHB_TABLE_MEMORY`        |  30          | Never                  | POWER8   | Never used or   |
> +|                                             |              |                        |          | Implemented     |
>   +---------------------------------------------+--------------+------------------------+----------+-----------------+
>   | :ref:`OPAL_PCI_SET_PE`                      |  31          | v1.0 (Initial Release) | POWER8   |                 |
>   +---------------------------------------------+--------------+------------------------+----------+-----------------+
> @@ -387,6 +388,8 @@ removed and no longer supported.
>   +---------------------------------------------+-------+-----------------------+-----------------------+
>   | :ref:`OPAL_PCI_SHPC`                        |  24   | Never                 |                       |
>   +---------------------------------------------+-------+-----------------------+-----------------------+
> +| :ref:`OPAL_PCI_SET_PHB_TABLE_MEMORY`        |  30   | Never                 |                       |
> ++---------------------------------------------+-------+-----------------------+-----------------------+
>   | :ref:`OPAL_WRITE_OPPANEL`                   |  43   | pre-v1.0              | pre-v1.0              |
>   +---------------------------------------------+-------+-----------------------+-----------------------+
>   | :ref:`OPAL_OLD_I2C_REQUEST`                 | 106   | v4.0                  | v4.0                  |
> @@ -419,6 +422,14 @@ OPAL_PCI_SHPC
>   A remnant of a long forgotten incarnation of OPAL. Never implemented, never
>   will be.
>   
> +.. _OPAL_PCI_SET_PHB_TABLE_MEMORY:
> +
> +OPAL_PCI_SET_PHB_TABLE_MEMORY
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +
> +A remnant of an old API design. Never implemented, never used. Only ever
> +returned :ref:`OPAL_UNSUPPORTED`, now the call is not implemented at all.
> +
>   .. _OPAL_WRITE_OPPANEL:
>   
>   OPAL_WRITE_OPPANEL
> diff --git a/include/opal-api.h b/include/opal-api.h
> index 535cca88f5c2..f767d3c199a9 100644
> --- a/include/opal-api.h
> +++ b/include/opal-api.h
> @@ -89,7 +89,7 @@
>   #define OPAL_PCI_PHB_MMIO_ENABLE		27
>   #define OPAL_PCI_SET_PHB_MEM_WINDOW		28
>   #define OPAL_PCI_MAP_PE_MMIO_WINDOW		29
> -#define OPAL_PCI_SET_PHB_TABLE_MEMORY		30
> +#define OPAL_PCI_SET_PHB_TABLE_MEMORY		30 /* never implemented */
>   #define OPAL_PCI_SET_PE				31
>   #define OPAL_PCI_SET_PELTV			32
>   #define OPAL_PCI_SET_MVE			33
> 

-- 
Andrew Donnellan              OzLabs, ADL Canberra
ajd at linux.ibm.com             IBM Australia Limited