>
Related use |
|--|---------------------------|-------------------------|
|--|---------------------------|-------------------------|
| | | |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|
| Goal | The AAL Application (e.g., O-DU) receives buffer(s) from the AAL in asynchronous mode with NULL buffer_handle input. | |
| Actors and Roles | AAL Application: calls AAL to receive the buffer.
AAL Implementation: executes receiveBuffer operation. | |
| Assumptions | This sequence is representative of how the AAL Application uses the receiveBuffer operation in an asynchronous manner with NULL buffer_handle input. | |
| Pre-conditions | At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started. | |
| Begins when | The AAL Application is ready to receive buffer. | |
| Steps 1-5 (CM) | In case of with callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receive. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating no buffers were received.
The AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation including the allocation of the buffers. The AAL returns the status of the operation, newly allocated buffer_handle(s) and the number of buffers received. | |
| Steps 6-10 (CM) | In case of with preregistered callback, the AAL Application calls the receiveBuffer API to receive buffer content from the AAL which will execute the receiveBuffer operation. In the case no buffers are ready to be received the AAL Implementation returns immediately indicating the status of the operation.
The AAL Implementation waits asynchronously for buffers to be received. The AAL allocates the buffers. Upon receiving buffers, the pre-registered callback function is executed to asynchronously inform the AAL Application that new buffers have been received. | |
| Steps 11-12 (M) | The AAL Application, when finished with the buffer, calls freeBuffer operation and the AAL will free the buffer back to the buffer pool. | |
| Ends when | receiveBuffer operation has completed. | |
| Exceptions | Exceptions can occur if the receiveBuffer operation fails. Status indicating failure will be returned in Step 1 or 5 or 8. | |
| Post Conditions | The AAL Application can continue processing. | |
| Traceability | To Be added later. | |
```
@startuml
Autonumber
Skinparam sequenceArrowThickness 2
skinparam ParticipantPadding 5
skinparam BoxPadding 10
autoactivate on
Box "O-RAN" #NavajoWhite
Participant "O-DU" as ODU << AAL-App>>
end box
Box "Cloud Platform" #lightseagreen
```
```
participant "AAL Implementation" as AAL
End box
activate ODU
ref over ODU, AAL
Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers
end ref
==Asynchronous Receive Buffer==
alt without callback
ODU -> AAL : receiveBuffer
deactivate ODU
note over AAL
If no buffers received return immediately.
In Asynchronous mode with no callback receive
API behaves in a poll mode manner.
endnote
AAL --> ODU : (number of buffers = 0)
activate ODU
ODU -> AAL : receiveBuffer
deactivate ODU
AAL -> AAL : Allocate buffer(s)
AAL --> ODU : success (number of buffers)
activate ODU
else with preregistered callback
ODU -> AAL : receiveBuffer
AAL --> ODU : return status
AAL -> AAL : wait for receive buffers
AAL -> AAL : Allocate buffer(s)
note over AAL
AAL executes receive operation.
endnote
AAL --> ODU : execute preregistered callback function
deactivate AAL
deactivate AAL
end
activate ODU
ODU -> AAL : freeBuffer
AAL --> ODU : success/failure
deactivate ODU
@enduml
```
The diagram illustrates the sequence of operations for the Asynchronous Receive Buffer API between the O-RAN and the Cloud Platform.
**Participants:**
- O-RAN:** Contains the «AAL-App» O-DU.
- Cloud Platform:** Contains the AAL Implementation.
**Sequence of Operations:**
- ref:** Section 5.3.3.1 Creating Buffer Pools and Allocating Buffers.
- alt [without callback]:**
- 1 receiveBuffer:** O-RAN sends to Cloud Platform.
- 2 (number of buffers = 0):** Cloud Platform returns to O-RAN.
- 3 receiveBuffer:** O-RAN sends to Cloud Platform.
- 4 Allocate buffer(s):** Cloud Platform performs internal action.
- 5 success (number of buffers):** Cloud Platform returns to O-RAN.
- [with preregistered callback]:**
- 6 receiveBuffer:** O-RAN sends to Cloud Platform.
- 7 return status:** Cloud Platform returns to O-RAN.
- 8 wait for receive buffers:** Cloud Platform performs internal action.
- 9 Allocate buffer(s):** Cloud Platform performs internal action.
- AAL executes receive operation:** Cloud Platform performs internal action.
- 10 execute preregistered callback function:** Cloud Platform returns to O-RAN.
- 11 freeBuffer:** O-RAN sends to Cloud Platform.
- 12 success/failure:** Cloud Platform returns to O-RAN.
**Notes:**
- If no buffers received return immediately. In Asynchronous mode with no callback receive API behaves in a poll mode manner.
- AAL executes receive operation.
Sequence diagram for Asynchronous Receive Buffer API between O-RAN and Cloud Platform.
## 5.4 AALI-C-App API details
### 5.4.1 Capabilities discovery and configuration
#### 5.4.1.1 initAal
Description: An AAL Application initializes the AAL Implementation.
Pre-conditions: AAL Application is started.
Triggers: Executed once by the AAL Application
Frequency: AAL Application Initialization time.
**Table 5.4.1.1-1: initAal operation**
| Operation | Direction |
|-----------|------------------------|
| initAal | AAL Application => AAL |
**Table 5.4.1.1-2: initAal Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|----------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| lpu_identifiers | 1..N | List Values | M | Optional list provided by DMS to the AAL Application that identifies the O-Cloud Resources and associated attributes that the DMS has assigned to and can be used by the AAL Application |
| vendor_specific | 0..N | List Key/Value pairs | | List of vendor specific attributes provided by the AAL Application. The AAL Application can obtain these parameters via the DMS or through another mechanism. |
**Table 5.4.1.1-3: initAal Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.1.2 cleanupAal
Description: This function must be called to allow the AAL implementation release any internal resources that the AAL implementation has allocated during initAal. After this call no other AALI-C-App API calls may be made.
Pre-conditions: initAal has been executed.
Triggers: Executed once by the AAL Application
Frequency: AAL Application termination time.
**Table 5.4.1.2-1: cleanupAal Operation**
| Operation | Direction |
|-----------|-----------|
|-----------|-----------|
| | |
|------------|------------------------|
| cleanupAal | AAL Application => AAL |
|------------|------------------------|
**Table 5.4.1.2-2: cleanupAal Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|-------------|
| NULL | 0 | | | |
**Table 5.4.1.2-3: cleanupAal Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.1.3 getAalLpuInfo
Description: An AAL Application queries the handle and capabilities of the AAL-LPU(s) assigned to the AAL Application. AAL-LPUs may provide different capabilities such as different AAL Profiles can be supported by the AAL-LPUs that includes different types of AAL-Profile-Instances and AAL-Profile-Queue(s). The aal-lpu-handle is unique between the AAL Application and the AAL-LPUs assigned to the AAL Application. The aal-lpu-handle is generated by the AAL Implementation.
Pre-conditions: AAL Application has at least one AAL-LPU assigned and available for use.
Triggers: On demand request from the AAL Application
Frequency: AAL Application Initialization time.
**Table 5.4.1.1-1: getAalLpuInfo operation**
| Operation | Direction |
|---------------|---------------------------|
| getAalLpuInfo | AAL => AAL Implementation |
**Table 5.4.1.1-2: getAalLpuInfo Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|-----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal_lpu_handle | 0 to 1 | | O | If supplied, the capabilities of only the AAL-LPU associated with the Handle is requested. If omitted, the capabilities of all the AAL-LPUs assigned to the AAL Application is requested. |
**Table 5.4.1.1-3: getAalLpuInfo Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal-lpu-cap-struct | 0 to many | struct | O | Struct containing the aal-lpu-handle and the capabilities supported by this AAL-LPU including AAL Profile type(s) that are available to the calling AAL Application. |
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
NOTE List of AAL Profile types to be defined, e.g. High-PHY. Types should also be versioned, e.g. High-PHY.V1
### 5.4.2 AALI-C-App Configuration Services
Before using AAL-Profile-Instance services the AAL Application must first create the AAL-Profile-Instance, then configure the AAL-Profile-Instance and the AAL-Profile-Queue(s).
#### 5.4.2.1 createAalProfileInstance
Description: The AAL Application creates an AAL-Profile-Instance on the AAL-LPU. The AAL-Profile-Instance is created based on the AAL Profile type that is requested by the AAL Application. The list of available AAL Profile type(s) is provided by the AALI in the getAalLpuInfo response. After successful creation, the AAL-Profile-Instance is in a 'in use, stopped' state. The AAL Application may now configure the AAL-Profile-Instance, AAL-Profile-Queue(s) and start the AAL-Profile-Instance.
This procedure may be repeated by the AAL Application in order to create multiple AAL-Profile-Instances, of the same or different AAL Profile types.
Pre-conditions: AAL Application has at least 1 AAL-LPU assigned and available for use. The AAL Profile type that is requested to be created is provided by the AAL-LPU (listed in the AAL-LPU-Capability struct of the getAalLpuInfo response operation).
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.1-1: createAalProfileInstance Operator**
| Operation | Direction |
|--------------------------|---------------------------------------|
| createAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.2.1-2: createAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------------------------------------------------------|
| aal_lpu_handle | 1 | N/A | M | The Handle of the AAL-LPU to create the AAL-Profile instance on. |
| aal_profile_instance_type | 1 | tbd | M | The type (and version) of an AAL-Profile-Instance (returned in the getAalLpuInfo operation) to create on this AAL-LPU |
**Table 5.4.2.1-3: createAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Status | 1 | | M | Result of the createProfileInstance operation |
| aal_profile_instance_handle | 1 | | C | Handle of the AAL-Profile instance created in this create AAL-Profile-Instance Request.
This field is only present if the createProfileInstance operation is successful |
| aal_profile_instance_config | 1 | Struct | C | Structure containing the default settings of the AAL-Profile-Instance. This field is only present if the createProfileInstance operation is successful. |
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-----------------------------------------------|
| Status | 1 | | M | Result of the createProfileInstance operation |
| status_of_operation | | Reference
WG10
object
model | M | Returns the status of the procedure |
#### 5.4.2.2 setAalProfileInstanceConfig
Description: The AAL Application configures the AAL-Profile-Instance on the AAL-LPU for a specific AAL Profile configuration for use by the AAL Application.
Pre-conditions: AAL Application has successfully created the AAL-LPU-Profile instance on the AAL-LPU. The AAL-Profile-Instance is not started.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.2-1: setAalProfileInstanceConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| setProfileInstanceConfig | AAL Application => AAL Implementation |
**Table 5.4.2.2-2: setAalProfileInstanceConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The Handle of the AAL-Profile-Instance to be configured. |
| aal_profile_instance_config | 1 | struct | M | Structure containing the AAL-Profile-Instance configuration to apply. |
**Table 5.4.2.2-3: setAalProfileInstanceConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference
WG10
object
model | M | Returns the status of the procedure |
#### 5.4.2.3 deleteAalProfileInstance
Description: The AAL Application may delete the AAL-Profile-Instance when it no longer requires it. For example, if a cell is deleted from the O-DU by upper layers or the OAM system, the AAL-Profile-Instance resources used to offload that cell can be deleted. After deleting the AAL-Profile-Instance, that AAL-Profile-Instance is no longer usable by the AAL Application.
Pre-conditions: The AAL Application has successfully stopped the AAL-Profile-Instance.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.3-1: deleteAalProfileInstance Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| deleteAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.2.3-2: deleteAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|---------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The Handle of the AAL-Profile-Instance to delete. |
**Table 5.4.2.3-3: deleteAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.2.4 setAalProfileQueueConfig
NOTE: Use of AAL-Profile-Queue operations for user plane data transfer and buffer API operations needs to be clarified.
Description: The AAL Application configures the AAL-Profile-Queue on the AAL-Profile-Instance.
If no AAL-Profile-Queue Handle is included, this operation will create and configure a new AAL-Profile-Queue. The response will include the AAL-Profile-Queue Handle for the AAL-Profile-Queue. To add an AAL-Profile-Queue to an AAL-Profile-Instance, the AAL-Profile-Instance must be stopped by the AAL Application.
If an AAL-Profile-Queue Handle is supplied, the configuration of the AAL-Profile-Queue identified by the AAL-Profile-Queue Handle is modified with the supplied configuration. Any items already on the queue are deleted when this operation is called. The AAL-Profile-Queue must be in the stopped state.
Pre-conditions: AAL-Profile-Instance has already successfully been created in the AAL-LPU. The AAL Application has successfully configured the AAL-Profile-Instance. The AAL-Profile-Queue (if already existing) is in the stopped state. To add an AAL-Profile-Queue to an AAL-Profile-Instance, the AAL-Profile-Instance must be stopped by the AAL Application. To re-configure an existing AAL-Profile-Queue on an AAL-Profile-Instance, the AAL-Profile-Instance does not need to be stopped by the AAL Application.
Triggers: On demand request from the AAL Application
Frequency: Infrequent.
**Table 5.4.2.4-1: setAalProfileQueueConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| setAalProfileQueueConfig | AAL Application => AAL Implementation |
**Table 5.4.2.4-2: setAalProfileQueueConfig Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aal-profile-instance-handle | 1 | | M | The Handle of the AAL-Profile-Instance |
| aal_profile_queue-handle | 1 | N/A | O | If this field is included, the operation is for an existing AAL-Profile-Queue.
If this field is omitted, a new AAL-Profile-Queue is being configured. |
| aal_profile_queue-config | 1 | struct | M | Structure containing the AAL-Profile-Queue configuration to apply. E.g.
Direction (Input or Output);
Max number of entries permitted.
Queue priority (relative to the other queues of the same direction associated with this AAL-Profile-Instance) |
**Table 5.4.2.4-2: setAalProfileQueueConfig Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|------------------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
| aal_profile_queue-handle | 0 to 1 | | C | If no AAL-Profile-Queue Handle was included in the request, a new AAL-Profile-Queue Handle is returned if the operation was successful. |
#### 5.4.2.5 getAalProfileQueueConfig
Description: The AAL Application may query the current AAL-Profile-Instance queue configuration.
Pre-conditions: AAL-Profile-Instance has already successfully been created in the AAL-LPU. The AAL Application has successfully created the AAL-Profile-Instance and the AAL-Profile-Queue.
Triggers: On demand request from the AAL Application
Frequency: N/A
**Table 5.4.2.5-1: getAalProfileQueueConfig Operation**
| Operation | Direction |
|--------------------------|---------------------------------------|
| getAalProfileQueueConfig | AAL Application => AAL Implementation |
**Table 5.4.2.5-2: getAalProfileQueueConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|----------------------------------------------------|
| aal_profile_queue-handle | 1 | N/A | | The handle of the AAL-Profile-Queue to be queried. |
**Table 5.4.2.5-3: getAalProfileQueueConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|------------------------------------|-----------|--------------------------------------------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
| aal_profile_queue_config | 1 | structure | C | On success the struct that contains the AAL-Profile-Queue configuration. |
#### 5.4.2.6 getAalProfileInstanceConfig
Description: The AAL Application may query the current configuration of the AAL-Profile-Instance.
Pre-conditions: AAL Application has successfully created the AAL-LPU-Profile instance on the AAL-LPU.
Triggers: On demand request from the AAL Application.
Frequency: Infrequent.
**Table 5.4.2.2-1: getAalProfileInstanceConfig Operation**
| Operation | Direction |
|-----------------------------|---------------------------------------|
| getAalProfileInstanceConfig | AAL Application => AAL Implementation |
**Table 5.4.2.2-2: getAalProfileInstanceConfig Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|----------------------------------------------------------|
| aal_profile_instance_handle | 1 | N/A | M | The handle of the AAL-Profile-Instance to be configured. |
**Table 5.4.2.2-3: getAalProfileInstanceConfig Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|------------------------------------|-----------|-----------------------------------------------------------------------|
| aal_profile_instance_config | 1 | struct | M | Structure containing the AAL-Profile-Instance configuration to apply. |
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
### 5.4.3 AALI-C-App Transport Operations
#### 5.4.3.1 createBufferPool
Description: The createBufferPool operation shall support creation of N buffer pools ( $N \geq 1$ ) of a specific buffer type, with buffer read/write access to the AAL Application.
- The AAL Application shall have the flexibility to invoke the createBufferPool operation either one time, or multiple times, to request creation of buffer pool(s) with multiple buffer sizes.
- The AAL Application shall invoke the createBufferPool operation multiple times for creation of buffer pools of different buffer types.
- The AAL Application shall not assume buffers in created buffer pools to be in a specific memory state (e.g., zero 'ed buffer).
- Buffer pool(s) and buffers are sharable by AAL-LPU(s).
- FFS: support for inter-accelerator buffer pool sharing.
Pre-conditions: AAL Implementation is initialized.
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.1-1: createBufferPool Operation**
| Operation | Direction |
|------------------|---------------------------------------|
| createBufferPool | AAL Application => AAL Implementation |
**Table 5.4.3.1-2: createBufferPool Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------------|-------------|-----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffer_pools | 1 | integer | M | Indicates the number of buffer pool(s) creation requested by the AAL Application |
| buffer_type | N | integer | M | Indicates the type(s) of content that can be placed in buffers allocated from the buffer pool(s).
AAL-Profile instances can share buffer pools of the same buffer type(s)
The buffer type values are identified within the AAL-Profile specification.
An empty list indicates that the buffer(s) within the buffer pool(s) do not have an intended type of content that can be placed in the buffer pool(s). |
| buffer_size | N | integer | M | Indicates the buffer size for each requested buffer pool
NOTE: |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------|-------------|-----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | | - AAL Application shall indicate N buffer sizes, when requesting for creation of N buffer pool(s) () in a single createBufferPool Operation
|
| number_of_buffers | N | integer | M | Indicates the size of each buffer pool, i.e., number of buffers available in each pool upon creation
NOTE: - AAL Application shall indicate N buffer pool sizes, when requesting for creation of N buffer pool(s), () in a single createBufferPool Operation
|
**Table 5.4.3.1-3: createBufferPool Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference
WG10
object model | M | Returns the status of the procedure. Indicates the status of createBufferPool Operation execution (TRUE for success, FALSE for failure)
If FALSE: Returns failure code if the AAL Implementation does not support pre-created buffer pools. |
| buffer_pool_handle | N | opaque handle | M | For each buffer pool, a handle to the pool
NOTE: Each buffer_pool_handle is associated with a specific buffer_size
A NULL shall be returned if the status_of_operation is FALSE (failure) |
#### 5.4.3.2 allocBuffer
Description: The allocBuffer operation shall support allocation of a buffer either from pre-created buffer pool(s), or from memory that is not associated with a pre-created buffer pool.
Pre-conditions: If a non-NULL buffer\_pool\_handle is passed, the buffers are allocated from the buffer pool(s) created using the createBufferPool operation.
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.2-1: allocBuffer Operation**
| Operation | Direction |
|-------------|---------------------------------------|
| allocBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.2-2: allocBuffer Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------|-------------|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| buffer_pool_handle | 1 | opaque handle | M | A handle to a pre-created buffer pool generated using createBufferPool operation or a NULL handle. When a NULL handle is passed, the AAL Implementation shall not use memory that is part of a pre-created buffer pool. |
| message_size | 1 | integer | M | Indicates message size (in bytes) for which the AAL Application is requesting buffer allocation
NOTE:
- The AAL Application shall not use the allocated buffer for a message greater than the indicated message_size.
- Whether/how an AAL Implementation takes into consideration message_size in allocating the buffer is transparent to the AAL Application.
When the value of the buffer_pool_handle is not NULL:
- The AAL Application shall request buffer allocation from a pre-created buffer pool with buffer_size message_size > 0
- The AAL Application can indicate the message_size equal to the buffer_size associated with the buffer_pool_handle.
- For optimal memory usage, AAL Application should indicate a buffer_pool_handle with associated buffer_size closest to the indicated memory size.
|
**Table 5.4.3.2-3: allocBuffer Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure. Indicates the status of allocBuffer Operation execution (TRUE for success, FALSE for failure)
NOTE: If the status of the operation is FALSE:
- Returns a failure code if the AAL Implementation requires buffers to be allocated from a pre-created buffer pool and the operation was invoked with buffer_pool_handle = NULL.
- Returns a failure code if the AAL Implementation does not support pre-created buffer pools and the operation was invoked with a buffer_pool_handle that is not NULL.
|
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|------------------|-------------|---------------|-----------|--------------------------------|
| | | | | |
| buffer_handle | 1 | opaque handle | M | Handle to the allocated buffer |
#### 5.4.3.3 getBufferAddr
Description: The getBufferAddr operation shall return address from buffer\_handle
Pre-conditions: The buffer\_handle is created using allocBuffer operation
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.3-1: getBufferAddr Operation**
| Operation | Direction |
|---------------|---------------------------------------|
| getBufferAddr | AAL Application => AAL Implementation |
**Table 5.4.3.3-2: getBufferAddr Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.3-3: getBufferAddr Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure. |
| buffer_address | 1 | void * | M | Pointer that points to the starting virtual address of the buffer for the AAL Application to use. On error, buffer address will be NULL value. |
#### 5.4.3.4 getBufferSize
Description: The getBufferSize operation shall return the size of the buffer from buffer\_handle
Pre-conditions: buffer\_handle is created using allocBuffer operation
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.4-1: getBufferSize Operation**
| Operation | Direction |
|-----------|-----------|
|-----------|-----------|
| | |
|---------------|---------------------------------------|
| getBufferSize | AAL Application => AAL Implementation |
|---------------|---------------------------------------|
**Table 5.4.3.4-2: getBufferSize Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.4-3: getBufferSize Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure.
Indicates the status of getBufferSize operation execution (TRUE for success, FALSE for failure) |
| buffer_size | 1 | Integer | M | Size of the buffer |
#### 5.4.3.5 sendBuffer
Description: The sendBuffer operation shall support enqueueing of N buffer(s) ( $N \geq 1$ ) by the AAL Application. The AAL Application shall either retain buffer ownership in sendBuffer operation or indicate buffer ownership transfer. AAL Application shall indicate the synchronization mode ('synchronous' or 'asynchronous') in sendBuffer operation.
AAL Implementation shall support both modes of operation.
- For synchronous mode, the AAL Implementation, upon execution completion of sendBuffer operation, shall return the status of the sendBuffer operation
- For asynchronous mode, AAL Implementation shall return the status of sendBuffer operation execution, only if AAL Application preregisters for a callback; otherwise AAL Implementation is not expected to return the execution status of the sendBuffer operation
FFS: Mechanism of sending details of AAL-Profile specific parameters
Pre-conditions: Buffers are allocated through allocBuffer operation. At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.5-1: sendBuffer Operation**
| Operation | Direction |
|------------|---------------------------------------|
| sendBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.5-2: sendBuffer Input Parameter**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|---------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffers | 1 | integer | M | Indicates number of enqueued buffer(s) ( $N \ge 1$ ) |
| per_buffer_config | N | structure | M | Structure containing attributes corresponding to enqueued buffer(s). |
| > buffer_handle | 1 | opaque handle | M | Indicates the buffer(s) containing metadata and payload to be sent. |
| > buffer_free | 1 | integer | M | When "TRUE" or 1, the AAL Application transfers ownership of the buffer to the AAL Implementation, which is expected to free the buffer upon completion of the sendBuffer operation, for each enqueued buffer.
When "FALSE" or 0, the AAL Application retains the ownership of the buffer and the AAL Implementation shall not automatically free the buffer upon completion of the sendBuffer operation. |
| aal_profile_instance_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Instance corresponding to the buffer payload(s) |
| aal_queue_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Queue associated with the enqueued buffer(s) |
| synchronization_mode | 1 | integer | M | Indicates synchronous/asynchronous mode of operation |
**Table 5.4.3.5-3: sendBuffer Output Parameter**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|-------------------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure.
Indicates the status of sendBuffer operation execution (success or failure) in synchronous mode and in asynchronous mode with preregistered callback
FFS: Details of callback preregistration mechanism |
| number_of_buffers_transmitted | 1 | integer | M | Indicates the total number of successfully transmitted buffers |
| status_of_each_buffer | N | bool | O | Optionally, returns status of each buffer (success or failure) |
#### 5.4.3.6 receiveBuffer
Description: The receiveBuffer operation shall support dequeuing up to N buffer(s) ( $N \geq 1$ ) by the AAL Application. The AAL Application shall indicate the synchronization mode ('synchronous' or 'asynchronous') in the receiveBuffer operation.
AAL Implementation shall support both modes of the operation.
- For synchronous mode, the AAL Implementation, upon execution completion of receiveBuffer operation, shall return the status of the receiveBuffer operation
- For asynchronous mode, the AAL Implementation shall return the status of receiveBuffer operation execution, only if AAL Application preregisters for a callback; otherwise AAL Implementation is not expected to return the execution status of the receiveBuffer operation
Either the AAL Application, or the AAL Implementation shall allocate the receiving buffer(s) either from buffer pool(s) pre-created through createBufferPool operation or from memory not mapped to a pre-created buffer pool.
Pre-conditions: At least one AAL-Profile-Instance is configured and started. At least one AAL-Profile-Queue is configured and started
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.6-1: receiveBuffer Operation**
| Operation | Direction |
|---------------|---------------------------------------|
| receiveBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.6-2: receiveBuffer Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|---------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| number_of_buffers | 1 | integer | M | Indicates maximum number of buffers ( $N \geq 1$ ) that can be dequeued by the AAL Application |
| buffer_handle | 0..N | opaque handle | M | Indicates dequeue buffer(s) allocated by the AAL Application.
If NULL, the AAL Implementation allocates the dequeue buffer(s) - The AAL Application shall not use the dequeue buffer(s) allocated by the AAL Implementation for any other subsequent send or receive operation
|
| aal_profile_instance_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Instance corresponding to the dequeued buffer payloads |
| aal_queue_handle | 1 | opaque handle | M | Indicates the AAL-Profile-Queue associated with the dequeued buffers |
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|----------------------|-------------|-----------|-----------|------------------------------------------------------|
| synchronization_mode | 1 | integer | M | Indicates synchronous/asynchronous mode of operation |
**Table 5.4.3.6-3: receiveBuffer Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|----------------------------|-------------|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference
WG10
object model | M | Returns the status of the procedure.
Indicates the status of receiveBuffer operation execution (success or failure) in synchronous mode and in asynchronous mode with preregistered callback
FFS: details of callback preregistration mechanism |
| number_of_received_buffers | 1 | integer | M | Indicates number of buffers (L) to be received by the AAL Application, which is < = maximum number of buffers (N) |
| buffer_handle | L | opaque handle | M | Indicates dequeue buffer(s) where from AAL Application retrieves the received data. |
| buffer_content_size | L | integer | O | Optionally, indicates the size (in bytes) of the contents of each received buffer |
#### 5.4.3.7 freeBuffer
Description: The freeBuffer operation shall free the buffer back to the buffer pool to which the buffer was allocated from.
- If the buffer is not freed in the sendBuffer operation (i.e., buffer\_free parameter is set to 0 or 'FALSE'), the freeBuffer operation shall free the buffer upon completion of the sendBuffer operation execution by the AAL Implementation.
Pre-conditions: The buffer\_handle is created using allocBuffer operation
Post-condition: Upon successful completion of the freeBuffer operation, the buffer\_handle is no longer usable by the AAL Application
Triggers: On demand request from the AAL Application
Frequency: No restriction
**Table 5.4.3.7-1: freeBuffer Operation**
| Operation | Direction |
|------------|---------------------------------------|
| freeBuffer | AAL Application => AAL Implementation |
**Table 5.4.3.7-2: freeBuffer Input Operation**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------|-------------|---------------|-----------|--------------------------------------------------------|
| buffer_handle | 1 | opaque handle | M | buffer object handle returned by allocBuffer operation |
**Table 5.4.3.7-3: freeBuffer Output Operation**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure.
Indicates the status of freeBuffer Operation execution (TRUE for success, FALSE for failure) |
#### 5.4.3.8 destroyBufferPool
Description: The destroyBufferPool operation shall support termination of buffer pool, which will make buffer\_handle(s) associated with the buffer pool unusable by the AAL Application.
Pre-condition: The buffer\_pool\_handle is created using createBufferPool operation
Trigger: On demand request from the AAL Application
Frequency: Infrequent
**Table 5.4.3.8-1: destroyBufferPool Operation**
| Operation | Direction |
|-------------------|---------------------------------------|
| destroyBufferPool | AAL Application => AAL Implementation |
**Table 5.4.3.8-2: destroyBufferPool Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------|-------------|---------------|-----------|---------------------------------------------|
| buffer_pool_handle | 1 | opaque handle | M | Indicates handle to pre-created buffer pool |
**Table 5.4.3.8-3: destroyBufferPool Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------|
| status_of_operation | 1 | Reference WG10 object model | M | Returns the status of the procedure.
Indicates the status of destroyBufferPool Operation execution (success or failure) |
### 5.4.4 AALI-C-App Administrative Operations
#### 5.4.4.1 startAalProfileInstance
Description: The AAL Application starts the AAL-Profile-Instance once it is ready to start operations.
Pre-conditions: AAL-LPU is started, AAL Application is successfully configured, AAL-Profile-Instance is configured. The AAL-Profile-Instance is in the stopped state.
On success, the AAL-Profile-Instance will be in the started state.
Triggers: On demand request from the AAL Application.
Frequency: Run time, infrequent.
**Table 5.4.4.1-1: startAalProfileInstance Operation**
| Operation | Direction |
|-------------------------|---------------------------------------|
| startAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.4.1-2: startAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|------------------------------------------------------|
| aal_profile_instance_handle | 1 | UUID | M | The identifier of the AAL-Profile-Instance to start. |
**Table 5.4.4.1-3: startAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
#### 5.4.4.2 stopAalProfileInstance
Description: The AAL Application stops the AAL-Profile-Instance.
Pre-conditions: AAL-LPU is started, AAL Application is configured and started, the AAL-Profile-Instance is configured and started.
On success, the AAL-Profile-Instance will be in the stopped state.
Triggers: On demand request from the AAL Application.
Frequency: Run time, infrequent.
**Table 5.4.4.2-1: stopAalProfileInstance Operation**
| Operation | Direction |
|------------------------|---------------------------------------|
| stopAalProfileInstance | AAL Application => AAL Implementation |
**Table 5.4.4.2-2: stopAalProfileInstance Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|-----------------------------|-------------|-----------|-----------|-----------------------------------------------------|
| aal_profile_instance_handle | 1 | UUID | M | The identifier of the AAL-Profile-Instance to stop. |
**Table 5.4.4.2-3: stopAalProfileInstance Output Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference
WG10
object
model | M | Returns the status of the procedure |
#### 5.4.4.3 startAalProfileQueue
Description: The AAL Application starts the AAL-Profile-Queue once it is ready to start operations.
Pre-conditions: AAL-LPU is started, AAL Application is successfully configured and started, AAL-Profile-Instance is configured and started, the AAL-Queue is configured and in stopped state.
Triggers: On demand request from the AAL Application.
Frequency: Run time.
**Table 5.4.4.3-1 startAalprofileQueue Operation**
| Operation | Direction |
|----------------------|---------------------------------------|
| startAalProfileQueue | AAL Application => AAL Implementation |
**Table 5.4.4.3-2: startAalprofileQueue Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|-----------------------------------------------------------------|
| aal-profile-queue-handle | 1 | N/A | | The handle or identification of the AAL-Profile_Queue to start. |
**Table 5.4.4.3-2: startAalprofileQueue Input Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|--------------------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference
WG10
object
model | M | Returns the status of the procedure |
#### 5.4.4.4 stopAalProfileQueue
Description: The AAL Application stops the AAL-Profile\_Queue.
Pre-conditions: AAL-LPU is started, AAL Application has successfully configured the AAL-Profile-Instance, AAL-Profile-Instance is configured and started, the AAL-Queue is configured and in started state.
Triggers: On demand request from the AAL Application
Frequency: Run time
**Table 5.4.4.4-1 stopAalProfileQueue Operation**
| Operation | Direction |
|---------------------|---------------------------------------|
| stopAalProfileQueue | AAL Application => AAL Implementation |
**Table 5.4.4.4-2: stopAalProfileQueue Input Parameters**
| Input Parameter | Cardinality | Data Type | Qualifier | Description |
|--------------------------|-------------|-----------|-----------|----------------------------------------------------------------|
| aal-profile-queue-handle | 1 | N/A | | The handle or identification of the AAL-Profile_Queue to stop. |
**Table 5.4.4.4-2: stopAalprofileQueue Input Parameters**
| Output Parameter | Cardinality | Data Type | Qualifier | Description |
|---------------------|-------------|-----------------------------|-----------|-------------------------------------|
| status_of_operation | | Reference WG10 object model | M | Returns the status of the procedure |
# Annex A (normative): Acceleration Capability Requirements
## A.1 Capability requirements used in the placement of an AAL Application to an AF
Table A.1-1 contains a list of acceleration capability requirements that are common across AAL implementations. These capability requirements are used by the AAL Application to identify their requirements for use of AFs and by the SMO and/or DMS when assigning the AAL Application with a selected AF.
**Table A.1-1: Acceleration Capability Requirements**
| Capability requirement name | Data Type/Description |
|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| aalProfileRequirement | Data Type: AalProfileRequirement
Description: The capability requirement for expressing what AAL-Profile is applicable when assigning an AAL-Profile to an AAL-LPU. |
| hwAcceleratorRequirement | Data Type: HwAccelRequirement
Description: The capability requirement for expressing what HW Accelerator is applicable when assigning an AAL-Profile to an AAL-LPU. |
| aalLpuRequirement | Data Type: AalLpuRequirement
Description: The capability requirements applicable when assigning an AAL-Profile to an AAL-LPU. |
**Table A.1-2: Attributes for AalProfileRequirement**
| Attribute name | Data Type/Description |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | Data Type: string
Description: The name of the AAL-Profile as defined in the corresponding AAL-Profile specification. |
| supportedVersions | Data Type: Array of string
Description: The versions of the AAL-Profile that the AAL Application can use. The version syntax is consistent with the version of the corresponding AAL-Profile specification. |
| preferredVersion | Data Type: string |
| Attribute name | Data Type/Description |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | Description: The preferred version of the AAL-Profile that the AAL Application can use. The version syntax is consistent with the version of the corresponding AAL-Profile specification. |
**Table A.1-3: Attributes for HwAccelRequirement**
| Attribute name | Data Type/Description |
|----------------|---------------------------------------------------------------------------------------------------------------------------------------|
| vendorName | Data Type: string
Description: The HW Accelerator's vendor that is needed to support the AAL Application. |
| model | Data Type: string
Description: The model of the HW Accelerator that is needed to support the AAL Application. |
| hwVersion | Data Type: string
Description: hardware version of the HW Accelerator that is needed to support the AAL Application. |
**Table A.1-4: Attributes for AalLpuRequirement**
| Attribute name | Data Type/Description |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| aalIDriver | Data Type: string
Description: The name of the AAL Implementation driver that is needed to support the AAL Application. |
# Annex (informative): Change History
| Date | Revision | Author | Description |
|-----------|----------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2022.2.28 | 00.00.01 | VMware, Ericsson, Wind River, Nvidia, Marvell, AT&T, Orange, Qualcomm | Initial skeleton |
| 2022.3.18 | 00.00.02 | VMware | Incorporated 2 CRs:
Management Objects Model CR (VMWare)
Common API Requirements CR (VMWare) |
| 2022.3.25 | 00.00.03 | NVIDIA, Intel, VMware | Incorporated 4 CRs:
Transport abstraction (NVIDIA)
AALI-C-App APIs (Intel)
AALI-C-Mgmt Workflow CR (VMWare)
AALI-C-Mgmt APIs CR (VMWare) |
| 2022.3.28 | 01.00 | Padma Sudarsan
VMware | Spec for final approval |
| 2022.5.12 | 01.00.01 | VMware | Incorporate CR:
Align AAL Definitions and Acronyms (Ericsson) |
| 2022.6.10 | 01.00.02 | Padma Sudarsan
VMware | Incorporate 7 CRs
AAL Transport Buffer Operations (Marvell)
AAL Transport API Operations (Nvidia)
AAL Transport Abstraction Requirements (Nvidia)
AAL-LPU start/Stop (Ericsson)
AAL Common API Spec Alignment (VMware)
AAL Get Accel Info part 1 (VMware)
AAL Common API e2e lcm flow (VMware et al.) |
| 2022.7.15 | 01.00.03 | Padma Sudarsan
VMware | Editor changes: |
| | | | |
|------------|----------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | Modified cover page, footer, copyright, and Annex Z per new template
Incorporate CRs:
AAL Common API AAL Application Operations (Ericsson)
Editor Changes:
Modify Naming Conventions for Operations/parameters
Identify sections that are still in progress
|
| 2022.7.20 | 01.00.04 | Padma Sudarsan
VMware | Incorporate CRs:
AAL Get Accel Info part 2 (VMware et al)
AAL Common API e2e lcm flow enhancement (Intel, VMware.)
AAL App Init Sequence alignment (VMware)
Buffer Pool Create Operation (Nvidia et al)
Buffer Send Operation (Nvidia et al)
Buffer Receive buffer pool destroy operation (Nvidia et al)
Editor Changes:
Modify Naming Conventions for Operations/parameters etc.
|
| 2022.7.21 | 01.00.05 | Padma Sudarsan
VMware | Incorporate CRs:
AAL-C-Transport Call flow (Nvidia et al)
|
| 2022.7.25 | 01.00.06 | Padma Sudarsan
VMware | Incorporate CRs:
AAL-C-Transport Call flow (Nvidia et al) update
Editorial Cleanup
|
| 2022.11.07 | 02.00.01 | Padma Sudarsan
VMware | Incorporate CRs:
AAL Transport API-freeBuffer clarification (Nvidia)
Transport Req. alignment with receiveBuffer and freeBuffer (Nvidia)
Transport receives buffer Operation clarification (Nvidia)
e2e lcm flow updates (VMware)
Correct UML in AALI-C-App API Init Sequence (Ericsson)
Add Detailed API Diagrams (Intel, Nvidia)
Update allocBuffer (Qualcomm)
Update createBufferPool (Qualcomm)
|
| | | | |
|------------|----------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2022.11.07 | 02.00.02 | Padma Sudarsan
VMware | Editorial corrections based on comments from the member companies. |
| 2022.12.05 | 03.00.01 | Padma Sudarsan
VMware | Incorporate Editorial corrections.
Editorial alignment of terminology (Qualcomm)
Fault management service with AALI-C-Mgmt (Qualcomm, VMware, Ericsson) |
| 2023.1.11 | 03.00.02 | Padma Sudarsan
VMware | Incorporate Editorial corrections |
| 2023.2.1 | 03.00.03 | Padma Sudarsan
VMware | Incorporate CRs:
Common API Mgmt Requirement Clarification (Ericsson)
AAL-AALI-C-MGMT uploadBootImage Removal (Ericsson)
AAL-Common-API-03.00-Add-Inv-Sub-Not (Qualcomm) |
| 2023.3.11 | 03.00.04 | Padma Sudarsan
VMware | Incorporate CRs:
CR 0027 AAL Common API Updates from F2F (Qualcomm)
Incorporate Editorial corrections |
| 2023.3.17 | 03.00.05 | Padma Sudarsan
VMware | Incorporate Editorial corrections |
| 2023.4.18 | 04.00.01 | Padma Sudarsan
VMware | Incorporate Editorial corrections |
| 2023.6.20 | 04.00.02 | Padma Sudarsan
VMware | Incorporated the following CRs:
QCM: Update description in setAalAccelConfig and vendor specific attribute in set and get
INT: Fix missing AALI-C-App Init API
INT: AAL Common: Fix and update AALI-C-App State diagram
QCM: AAL Common: AAL IM Diagrams
QCM: AAL Common: AAL IM Management Definitions
QCM: AAL Common: AAL IM App Definitions
VMW: AAL Common: Changing Arch reference |
| 2023.6.28 | 04.00.03 | Padma Sudarsan
VMware | Incorporated the following CRs:
QCM: AAL Common Fix AAL IM Namespace |
| 2023.7.21 | 04.00.04 | Padma Sudarsan
VMware | Incorporated editorial comment |
| 2023.9.14 | 05.00.01 | Padma Sudarsan
VMware | Incorporated the following CRs: |
| | | | |
|-----------|----------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | NOK: Clarification on AALI-C-Mgmt Inventory Notification Parameters
WNDR: AALI-C-Mgmt HAM registration
Incorporate Editorial comments
|
| 2023.11.7 | 05.00.02 | Padma Sudarsan
VMware
| Incorporate the following CRs.
QCM: Remove reference to Alarm Dictionary
QCM: Add HAM IM State
QCM: AAL Common Add Capabilities
QCM: Add HAM IM
QCM: Fix DMS AAL Scenarios Requirement
Incorporate Editorial comments.
|
| 2024-1-22 | 06.00.01 | Padma Sudarsan
VMware by Broadcom
| Incorporate the following CRs:
DCM-2023.10.24-WG6-commonAPI__CR001_scope_overview_v03
QCM-2023.12.01-WG6-CR-0052-Common-API-Add-aalLpuConfig attribute to LPU
QCM-2023.12.11-WG6-CR-0055-Common-API-Add-LPU-HW-Accel-Conditions
QCM-2023.12.11-WG6-CR-0058-Common-API-Remove-PM-Dictionary
QCM-2023.12.21-WG6-CR-0049-Common-API-Add-Capability-Advertisement
QCM-2023.12.21-WG6-CR-0056-Common-API-Identify-Common-Requirements
QCM-2023.11.30-WG6-CR-0051-Common-API-Remove_OCloud_Resource_Ref
|
| 2024-1-22 | 06.00.02 | Padma Sudarsan
VMware by Broadcom
| Incorporate the following CRs:
NOK-2023.10.11-WG6-CR0083-AAL-Common-HAM_IM v00.06
DCM-2023.01.19-WG6-commonAPI__CR002_HAM_func_requirements_v06
DCM-2023.10.24-WG6-commonAPI__CR003_c-mgmt requirements_v04
NOK-2023.12.11-WG6-CR-AAL Common API Mgmt_requirement_v03
DCM-2024.01.22-WG6-commonAPI__CR007_transport_abstraction framework_v1
ERI-2024.1.18-WG6-CR-0044-AAL Common API UUID definition and reference_v3
|
| | | | |
|-----------|----------|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | | | ERI-2024.1.23-WG6-CR-0045-AAL Common API URI reference and acronym_v4 |
| 2024-3-17 | 06.00.03 | Padma Sudarsan
VMware by Broadcom | DCM-2023.10.24-WG6-commonAPI__CR003_c-mgmt requirements_v05
ERI - 20240110-WG6-CR-0041-AAL Common-API - Removal of AALI-C-App requirements for interaction with DMS v04
ERI-2024.1.18-WG6-CR-0043-AAL Common API AAL resource identifier requirements_v7 |
| 2024-3-19 | 06.00.04 | Padma Sudarsan
VMware by Broadcom | Editorial updates |
| 2024-4-18 | 07.00.01 | Padma Sudarsan
VMware by Broadcom | Incorporate CR
ERI-2024.04.05-WG6-CR-0047-AAL Common API Re-add AALI-C-App Operations section accidentally removed in version 01.03 v2
Editorial changes |
| 2024-7-5 | 07.00.02 | Padma Sudarsan
VMware by Broadcom | Incorporate CR
NOK-2024.04.08-WG6-CR0112-AAL_CommonAPI-EditorialRemovalOfDuplicateText
QCM-2024.04.10-WG6-AAL-Common-CR-0063-Update-IM-Namespace
ERI-2024.04.05-WG6-CR-0048-AAL Common API Update ALI-C-App State Diagram v4 |
# History
| Date | Revision | Description |
|------------|----------|---------------------------------|
| 2022.03.28 | 01.00 | Published from version 00.00.03 |
| 2022.08.01 | 02.00 | Published from version 01.00.06 |
| 2022.11.21 | 03.00 | Published from version 02.00.02 |
| 2023.03.27 | 04.00 | Published from version 03.00.05 |
| 2023.07.31 | 05.00 | Published from version 04.00.04 |
| 2023.11.27 | 06.00 | Published from version 05.00.02 |
| 2024.4.10 | 07.00 | Published from version 06.00.04 |
| 2024.7.31 | 08.00 | Published from version 07.00.02 |