close Warning: Can't synchronize with repository "(default)" (/common/SVN/wimax does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 8 and Version 9 of Old/WiMAX/16


Ignore:
Timestamp:
Dec 9, 2010, 7:22:40 PM (10 years ago)
Author:
hmussman
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Old/WiMAX/16

    v8 v9  
    139139-       Successful execution of this function returns “ok” from the grid service, “no” otherwise
    140140}}}
     141
     142
     143= Radio Management API (User Exposed) =
     144
     145These API define the calls that can be made by the system user for controlling radio-related features of the WiMAX system. These API are further classified based on the functionality they provide.
     146== Custom Service Class Suport ==
     147These APIs will allow the user to create user-defined service flow types apart from the 5 standard service flows supported as a part of the current model.
     148=== createServiceFlow(SlideID, direction, priority, classifier-ips, classifier-ports, service_type, service_params) ===
     149-       Direction – Uplink or downlink for the class.
     150-       Priority – priority of the service class
     151-       Classifier-ips TLV -  Source/Destination IP classifiers for flow classification
     152-       Classifier-ports TLV – Source/Destination port classifiers for flow classification.
     153-       Service_type -  One of the five types – BE/UGS/rtPS/nrtPS/ertPS
     154-       Service params is the TLV for each service type
     155-       Return type:  Service type id - STID (integer) > 6. 1-5 are reserved for the default service flow types.
     156-       Note that the service type is created by the Radio management grid service for
     157        a specific slice ID and hence it will be specific to that slice.
     158=== createServiceClass(SlideID,STIDs{}) ===
     159-       SliceID identifies the requesting slice.
     160-       STIDs are the service type ids.
     161-       Success returns the Service class ID (SCID), which can be used in install or remove.
     162=== installServiceClass(SlideID,SCID) ===
     163-       SliceID identifies the requesting slice.
     164-       Installs all the service flows that are part of the service class SCID.
     165-       Success results in end – to – end datapath setup between wireless clients and virtual machine slice.
     166=== uninstallServiceClass(SlideID,SCID) ===
     167-       SliceID identifies the requesting slice.
     168-       Un-installs all the service flows that are part of the service class SCID.
     169-       Success returns ok and nok otherwise.
     170
     171=== deleteServiceClass(SlideID, SCID) ===
     172-       Deletes the service class corresponding to the specification in the request.
     173-       Returns success if the service class could be successfully deleted (none of the
     174flows are actively using these service classifiers).
     175
     176=== deleteServiceFlow(SlideID, STID) ===
     177-       Results in deletion of service flow type identified by STID if any such flow type exists.
     178-       Success results in “ok” and “nok” otherwise.
     179
     180
     181== Slice Radio Control ==
     182
     183=== setMinimalMcs(SliceID, MSID, SCID, mcs) ===
     184-       Used to set the minimal modulation and coding scheme (MCS) to be used for
     185that service class. An auto rate provision will select a better MCS based on the
     186observed CINR conditions.
     187-       The user can chose one among available MCSs as an option for that class.
     188-       We are still exploring the possibility of setting this per class per MSID. As per our
     189current understanding, this is difficult.
     190
     191=== setFixedMcs(SliceID, MSID, SCID, mcs) ===
     192-       Used to set a fixed MCS for a particular service class.
     193-       This disables the automatic MCS adjustment using measured CINR.
     194-       If possible we wish to set this mcs value per MSID.
     195
     196=== setRadioResource(SliceID, MSID,  RR) ===
     197-       Information provided by this function should be consulted during initial ranging and connection setup.
     198-       RR  – Radio resource uplink + downlink (set in % - 0 to 100)
     199
     200=== setBandwithUlDlRatio(bandwidth UL_DL_ratio) ===
     201-       Set supported bandwidth: 10M, 7.5M, 5M Hz
     202-   Based on  RR allocation in set_radio_resource(), this routine allows the user to set
     203the uplink-downlink ratio as a fraction of the RR.
     204-       UL_DL_ratio is used as a key to select one among standard UL_DL ratio supported by the BS. All MS has to use the same ul_dl_ratio
     205
     206== Slice Radio Monitoring ==
     207
     208=== getAllClientsInfo( SLICEID ) ===
     209-       Returns the number of WiMAX clients associated with a particular SLICEID.
     210-       Return value ranges between 0 and maximum number of clients that can be owned by a slice on success, “nok” otherwise
     211
     212=== getClientInfo(SLICE ID, MSID) ===
     213-       Returns detailed information about a single client in the network.
     214-       Information for individual MAC address includes the amount of disk quota, disk space used, and the CPU quota (reserved and used).
     215-       Returns XML with appropriate parameters on success, “nok” otherwise
     216
     217=== getSliceResource(SLICEID) ===
     218-       This mechanism allows every slice to monitor its current usage,  and the limits
     219-       Values returned may vary based on the virtualization technology used - (disk space, CPU).
     220-       Returns XML with appropriate parameters on success, “nok” otherwise