net/caif/cfcnfg.c

   1 /*
   2  * Copyright (C) ST-Ericsson AB 2010
   3  * Author:      Sjur Brendeland/sjur.brandeland@stericsson.com
   4  * License terms: GNU General Public License (GPL) version 2
   5  */
   6 #include <linux/kernel.h>
   7 #include <linux/stddef.h>
   8 #include <linux/slab.h>
   9 #include <net/caif/caif_layer.h>
  10 #include <net/caif/cfpkt.h>
  11 #include <net/caif/cfcnfg.h>
  12 #include <net/caif/cfctrl.h>
  13 #include <net/caif/cfmuxl.h>
  14 #include <net/caif/cffrml.h>
  15 #include <net/caif/cfserl.h>
  16 #include <net/caif/cfsrvl.h>
  17
  18 #include <linux/module.h>
  19 #include <asm/atomic.h>
  20
  21 #define MAX_PHY_LAYERS 7
  22 #define PHY_NAME_LEN 20
  23
  24 #define container_obj(layr) container_of(layr, struct cfcnfg, layer)
  25
  26 /* Information about CAIF physical interfaces held by Config Module in order
  27  * to manage physical interfaces
  28  */
  29 struct cfcnfg_phyinfo {
  30         /* Pointer to the layer below the MUX (framing layer) */
  31         struct cflayer *frm_layer;
  32         /* Pointer to the lowest actual physical layer */
  33         struct cflayer *phy_layer;
  34         /* Unique identifier of the physical interface */
  35         unsigned int id;
  36         /* Preference of the physical in interface */
  37         enum cfcnfg_phy_preference pref;
  38
  39         /* Reference count, number of channels using the device */
  40         int phy_ref_count;
  41
  42         /* Information about the physical device */
  43         struct dev_info dev_info;
  44 };
  45
  46 struct cfcnfg {
  47         struct cflayer layer;
  48         struct cflayer *ctrl;
  49         struct cflayer *mux;
  50         u8 last_phyid;
  51         struct cfcnfg_phyinfo phy_layers[MAX_PHY_LAYERS];
  52 };
  53
  54 static void cfcnfg_linkup_rsp(struct cflayer *layer, u8 channel_id,
  55                              enum cfctrl_srv serv, u8 phyid,
  56                              struct cflayer *adapt_layer);
  57 static void cfcnfg_linkdestroy_rsp(struct cflayer *layer, u8 channel_id,
  58                                   struct cflayer *client_layer);
  59 static void cfcnfg_reject_rsp(struct cflayer *layer, u8 channel_id,
  60                              struct cflayer *adapt_layer);
  61 static void cfctrl_resp_func(void);
  62 static void cfctrl_enum_resp(void);
  63
  64 struct cfcnfg *cfcnfg_create(void)
  65 {
  66         struct cfcnfg *this;
  67         struct cfctrl_rsp *resp;
  68         /* Initiate this layer */
  69         this = kmalloc(sizeof(struct cfcnfg), GFP_ATOMIC);
  70         if (!this) {
  71                 pr_warning("CAIF: %s(): Out of memory\n", __func__);
  72                 return NULL;
  73         }
  74         memset(this, 0, sizeof(struct cfcnfg));
  75         this->mux = cfmuxl_create();
  76         if (!this->mux)
  77                 goto out_of_mem;
  78         this->ctrl = cfctrl_create();
  79         if (!this->ctrl)
  80                 goto out_of_mem;
  81         /* Initiate response functions */
  82         resp = cfctrl_get_respfuncs(this->ctrl);
  83         resp->enum_rsp = cfctrl_enum_resp;
  84         resp->linkerror_ind = cfctrl_resp_func;
  85         resp->linkdestroy_rsp = cfcnfg_linkdestroy_rsp;
  86         resp->sleep_rsp = cfctrl_resp_func;
  87         resp->wake_rsp = cfctrl_resp_func;
  88         resp->restart_rsp = cfctrl_resp_func;
  89         resp->radioset_rsp = cfctrl_resp_func;
  90         resp->linksetup_rsp = cfcnfg_linkup_rsp;
  91         resp->reject_rsp = cfcnfg_reject_rsp;
  92
  93         this->last_phyid = 1;
  94
  95         cfmuxl_set_uplayer(this->mux, this->ctrl, 0);
  96         layer_set_dn(this->ctrl, this->mux);
  97         layer_set_up(this->ctrl, this);
  98         return this;
  99 out_of_mem:
 100         pr_warning("CAIF: %s(): Out of memory\n", __func__);
 101         kfree(this->mux);
 102         kfree(this->ctrl);
 103         kfree(this);
 104         return NULL;
 105 }
 106 EXPORT_SYMBOL(cfcnfg_create);
 107
 108 void cfcnfg_remove(struct cfcnfg *cfg)
 109 {
 110         if (cfg) {
 111                 kfree(cfg->mux);
 112                 kfree(cfg->ctrl);
 113                 kfree(cfg);
 114         }
 115 }
 116
 117 static void cfctrl_resp_func(void)
 118 {
 119 }
 120
 121 static void cfctrl_enum_resp(void)
 122 {
 123 }
 124
 125 struct dev_info *cfcnfg_get_phyid(struct cfcnfg *cnfg,
 126                                   enum cfcnfg_phy_preference phy_pref)
 127 {
 128         u16 i;
 129
 130         /* Try to match with specified preference */
 131         for (i = 1; i < MAX_PHY_LAYERS; i++) {
 132                 if (cnfg->phy_layers[i].id == i &&
 133                      cnfg->phy_layers[i].pref == phy_pref &&
 134                      cnfg->phy_layers[i].frm_layer != NULL) {
 135                         caif_assert(cnfg->phy_layers != NULL);
 136                         caif_assert(cnfg->phy_layers[i].id == i);
 137                         return &cnfg->phy_layers[i].dev_info;
 138                 }
 139         }
 140         /* Otherwise just return something */
 141         for (i = 1; i < MAX_PHY_LAYERS; i++) {
 142                 if (cnfg->phy_layers[i].id == i) {
 143                         caif_assert(cnfg->phy_layers != NULL);
 144                         caif_assert(cnfg->phy_layers[i].id == i);
 145                         return &cnfg->phy_layers[i].dev_info;
 146                 }
 147         }
 148
 149         return NULL;
 150 }
 151
 152 static struct cfcnfg_phyinfo *cfcnfg_get_phyinfo(struct cfcnfg *cnfg,
 153                                                         u8 phyid)
 154 {
 155         int i;
 156         /* Try to match with specified preference */
 157         for (i = 0; i < MAX_PHY_LAYERS; i++)
 158                 if (cnfg->phy_layers[i].frm_layer != NULL &&
 159                     cnfg->phy_layers[i].id == phyid)
 160                         return &cnfg->phy_layers[i];
 161         return NULL;
 162 }
 163
 164 int cfcnfg_get_named(struct cfcnfg *cnfg, char *name)
 165 {
 166         int i;
 167
 168         /* Try to match with specified name */
 169         for (i = 0; i < MAX_PHY_LAYERS; i++) {
 170                 if (cnfg->phy_layers[i].frm_layer != NULL
 171                     && strcmp(cnfg->phy_layers[i].phy_layer->name,
 172                               name) == 0)
 173                         return cnfg->phy_layers[i].frm_layer->id;
 174         }
 175         return 0;
 176 }
 177
 178 /*
 179  * NOTE: What happens on destroy failure:
 180  *       1a) No response - Too early
 181  *            This will not happen because enumerate has already
 182  *            completed.
 183  *       1b) No response - FATAL
 184  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 185  *            Modem error, response is really expected -  this
 186  *            case is not really handled.
 187  *       2) O/E-bit indicate error
 188  *            Ignored - this link is destroyed anyway.
 189  *       3) Not able to match on request
 190  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 191  *       4) Link-Error - (no response)
 192  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 193  */
 194 int cfcnfg_disconn_adapt_layer(struct cfcnfg *cnfg, struct cflayer *adap_layer)
 195 {
 196         u8 channel_id = 0;
 197         int ret = 0;
 198         struct cfcnfg_phyinfo *phyinfo = NULL;
 199         u8 phyid = 0;
 200
 201         caif_assert(adap_layer != NULL);
 202         channel_id = adap_layer->id;
 203         if (channel_id == 0) {
 204                 pr_err("CAIF: %s():adap_layer->id is 0\n", __func__);
 205                 ret = -ENOTCONN;
 206                 goto end;
 207         }
 208
 209         if (adap_layer->dn == NULL) {
 210                 pr_err("CAIF: %s():adap_layer->dn is NULL\n", __func__);
 211                 ret = -ENODEV;
 212                 goto end;
 213         }
 214
 215         if (adap_layer->dn != NULL)
 216                 phyid = cfsrvl_getphyid(adap_layer->dn);
 217
 218         phyinfo = cfcnfg_get_phyinfo(cnfg, phyid);
 219         if (phyinfo == NULL) {
 220                 pr_warning("CAIF: %s(): No interface to send disconnect to\n",
 221                            __func__);
 222                 ret = -ENODEV;
 223                 goto end;
 224         }
 225
 226         if (phyinfo->id != phyid
 227                 || phyinfo->phy_layer->id != phyid
 228                 || phyinfo->frm_layer->id != phyid) {
 229
 230                 pr_err("CAIF: %s(): Inconsistency in phy registration\n",
 231                         __func__);
 232                 ret = -EINVAL;
 233                 goto end;
 234         }
 235
 236         ret = cfctrl_linkdown_req(cnfg->ctrl, channel_id, adap_layer);
 237
 238 end:
 239         if (phyinfo != NULL && --phyinfo->phy_ref_count == 0 &&
 240                 phyinfo->phy_layer != NULL &&
 241                 phyinfo->phy_layer->modemcmd != NULL) {
 242                 phyinfo->phy_layer->modemcmd(phyinfo->phy_layer,
 243                                              _CAIF_MODEMCMD_PHYIF_USELESS);
 244         }
 245         return ret;
 246
 247 }
 248 EXPORT_SYMBOL(cfcnfg_disconn_adapt_layer);
 249
 250 static void cfcnfg_linkdestroy_rsp(struct cflayer *layer, u8 channel_id,
 251                                   struct cflayer *client_layer)
 252 {
 253         struct cfcnfg *cnfg = container_obj(layer);
 254         struct cflayer *servl;
 255
 256         /*
 257          * 1) Remove service from the MUX layer. The MUX must
 258          *    guarante that no more payload sent "upwards" (receive)
 259          */
 260         servl = cfmuxl_remove_uplayer(cnfg->mux, channel_id);
 261
 262         if (servl == NULL) {
 263                 pr_err("CAIF: %s(): PROTOCOL ERROR "
 264                        "- Error removing service_layer Channel_Id(%d)",
 265                         __func__, channel_id);
 266                 return;
 267         }
 268         caif_assert(channel_id == servl->id);
 269
 270         if (servl != client_layer && servl->up != client_layer) {
 271                 pr_err("CAIF: %s(): Error removing service_layer "
 272                        "Channel_Id(%d) %p %p",
 273                         __func__, channel_id, (void *) servl,
 274                         (void *) client_layer);
 275                 return;
 276         }
 277
 278         /*
 279          * 2) DEINIT_RSP must guarantee that no more packets are transmitted
 280          *    from client (adap_layer) when it returns.
 281          */
 282
 283         if (servl->ctrlcmd == NULL) {
 284                 pr_err("CAIF: %s(): Error servl->ctrlcmd == NULL", __func__);
 285                 return;
 286         }
 287
 288         servl->ctrlcmd(servl, CAIF_CTRLCMD_DEINIT_RSP, 0);
 289
 290         /* 3) It is now safe to destroy the service layer. */
 291         cfservl_destroy(servl);
 292 }
 293
 294 /*
 295  * NOTE: What happens on linksetup failure:
 296  *       1a) No response - Too early
 297  *            This will not happen because enumerate is secured
 298  *            before using interface.
 299  *       1b) No response - FATAL
 300  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 301  *            Modem error, response is really expected -  this case is
 302  *            not really handled.
 303  *       2) O/E-bit indicate error
 304  *            Handled in cnfg_reject_rsp
 305  *       3) Not able to match on request
 306  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 307  *       4) Link-Error - (no response)
 308  *            Not handled, but this should be a CAIF PROTOCOL ERROR
 309  */
 310
 311 int
 312 cfcnfg_add_adaptation_layer(struct cfcnfg *cnfg,
 313                                 struct cfctrl_link_param *param,
 314                                 struct cflayer *adap_layer)
 315 {
 316         struct cflayer *frml;
 317         if (adap_layer == NULL) {
 318                 pr_err("CAIF: %s(): adap_layer is zero", __func__);
 319                 return -EINVAL;
 320         }
 321         if (adap_layer->receive == NULL) {
 322                 pr_err("CAIF: %s(): adap_layer->receive is NULL", __func__);
 323                 return -EINVAL;
 324         }
 325         if (adap_layer->ctrlcmd == NULL) {
 326                 pr_err("CAIF: %s(): adap_layer->ctrlcmd == NULL", __func__);
 327                 return -EINVAL;
 328         }
 329         frml = cnfg->phy_layers[param->phyid].frm_layer;
 330         if (frml == NULL) {
 331                 pr_err("CAIF: %s(): Specified PHY type does not exist!",
 332                         __func__);
 333                 return -ENODEV;
 334         }
 335         caif_assert(param->phyid == cnfg->phy_layers[param->phyid].id);
 336         caif_assert(cnfg->phy_layers[param->phyid].frm_layer->id ==
 337                      param->phyid);
 338         caif_assert(cnfg->phy_layers[param->phyid].phy_layer->id ==
 339                      param->phyid);
 340         /* FIXME: ENUMERATE INITIALLY WHEN ACTIVATING PHYSICAL INTERFACE */
 341         cfctrl_enum_req(cnfg->ctrl, param->phyid);
 342         cfctrl_linkup_request(cnfg->ctrl, param, adap_layer);
 343         return 0;
 344 }
 345 EXPORT_SYMBOL(cfcnfg_add_adaptation_layer);
 346
 347 static void cfcnfg_reject_rsp(struct cflayer *layer, u8 channel_id,
 348                              struct cflayer *adapt_layer)
 349 {
 350         if (adapt_layer != NULL && adapt_layer->ctrlcmd != NULL)
 351                 adapt_layer->ctrlcmd(adapt_layer,
 352                                      CAIF_CTRLCMD_INIT_FAIL_RSP, 0);
 353 }
 354
 355 static void
 356 cfcnfg_linkup_rsp(struct cflayer *layer, u8 channel_id, enum cfctrl_srv serv,
 357                  u8 phyid, struct cflayer *adapt_layer)
 358 {
 359         struct cfcnfg *cnfg = container_obj(layer);
 360         struct cflayer *servicel = NULL;
 361         struct cfcnfg_phyinfo *phyinfo;
 362         if (adapt_layer == NULL) {
 363                 pr_err("CAIF: %s(): PROTOCOL ERROR "
 364                         "- LinkUp Request/Response did not match\n", __func__);
 365                 return;
 366         }
 367
 368         caif_assert(cnfg != NULL);
 369         caif_assert(phyid != 0);
 370         phyinfo = &cnfg->phy_layers[phyid];
 371         caif_assert(phyinfo != NULL);
 372         caif_assert(phyinfo->id == phyid);
 373         caif_assert(phyinfo->phy_layer != NULL);
 374         caif_assert(phyinfo->phy_layer->id == phyid);
 375
 376         if (phyinfo != NULL &&
 377             phyinfo->phy_ref_count++ == 0 &&
 378             phyinfo->phy_layer != NULL &&
 379             phyinfo->phy_layer->modemcmd != NULL) {
 380                 caif_assert(phyinfo->phy_layer->id == phyid);
 381                 phyinfo->phy_layer->modemcmd(phyinfo->phy_layer,
 382                                              _CAIF_MODEMCMD_PHYIF_USEFULL);
 383
 384         }
 385         adapt_layer->id = channel_id;
 386
 387         switch (serv) {
 388         case CFCTRL_SRV_VEI:
 389                 servicel = cfvei_create(channel_id, &phyinfo->dev_info);
 390                 break;
 391         case CFCTRL_SRV_DATAGRAM:
 392                 servicel = cfdgml_create(channel_id, &phyinfo->dev_info);
 393                 break;
 394         case CFCTRL_SRV_RFM:
 395                 servicel = cfrfml_create(channel_id, &phyinfo->dev_info);
 396                 break;
 397         case CFCTRL_SRV_UTIL:
 398                 servicel = cfutill_create(channel_id, &phyinfo->dev_info);
 399                 break;
 400         case CFCTRL_SRV_VIDEO:
 401                 servicel = cfvidl_create(channel_id, &phyinfo->dev_info);
 402                 break;
 403         case CFCTRL_SRV_DBG:
 404                 servicel = cfdbgl_create(channel_id, &phyinfo->dev_info);
 405                 break;
 406         default:
 407                 pr_err("CAIF: %s(): Protocol error. "
 408                         "Link setup response - unknown channel type\n",
 409                         __func__);
 410                 return;
 411         }
 412         if (!servicel) {
 413                 pr_warning("CAIF: %s(): Out of memory\n", __func__);
 414                 return;
 415         }
 416         layer_set_dn(servicel, cnfg->mux);
 417         cfmuxl_set_uplayer(cnfg->mux, servicel, channel_id);
 418         layer_set_up(servicel, adapt_layer);
 419         layer_set_dn(adapt_layer, servicel);
 420         servicel->ctrlcmd(servicel, CAIF_CTRLCMD_INIT_RSP, 0);
 421 }
 422
 423 void
 424 cfcnfg_add_phy_layer(struct cfcnfg *cnfg, enum cfcnfg_phy_type phy_type,
 425                      void *dev, struct cflayer *phy_layer, u16 *phyid,
 426                      enum cfcnfg_phy_preference pref,
 427                      bool fcs, bool stx)
 428 {
 429         struct cflayer *frml;
 430         struct cflayer *phy_driver = NULL;
 431         int i;
 432
 433
 434         if (cnfg->phy_layers[cnfg->last_phyid].frm_layer == NULL) {
 435                 *phyid = cnfg->last_phyid;
 436
 437                 /* range: * 1..(MAX_PHY_LAYERS-1) */
 438                 cnfg->last_phyid =
 439                     (cnfg->last_phyid % (MAX_PHY_LAYERS - 1)) + 1;
 440         } else {
 441                 *phyid = 0;
 442                 for (i = 1; i < MAX_PHY_LAYERS; i++) {
 443                         if (cnfg->phy_layers[i].frm_layer == NULL) {
 444                                 *phyid = i;
 445                                 break;
 446                         }
 447                 }
 448         }
 449         if (*phyid == 0) {
 450                 pr_err("CAIF: %s(): No Available PHY ID\n", __func__);
 451                 return;
 452         }
 453
 454         switch (phy_type) {
 455         case CFPHYTYPE_FRAG:
 456                 phy_driver =
 457                     cfserl_create(CFPHYTYPE_FRAG, *phyid, stx);
 458                 if (!phy_driver) {
 459                         pr_warning("CAIF: %s(): Out of memory\n", __func__);
 460                         return;
 461                 }
 462
 463                 break;
 464         case CFPHYTYPE_CAIF:
 465                 phy_driver = NULL;
 466                 break;
 467         default:
 468                 pr_err("CAIF: %s(): %d", __func__, phy_type);
 469                 return;
 470                 break;
 471         }
 472
 473         phy_layer->id = *phyid;
 474         cnfg->phy_layers[*phyid].pref = pref;
 475         cnfg->phy_layers[*phyid].id = *phyid;
 476         cnfg->phy_layers[*phyid].dev_info.id = *phyid;
 477         cnfg->phy_layers[*phyid].dev_info.dev = dev;
 478         cnfg->phy_layers[*phyid].phy_layer = phy_layer;
 479         cnfg->phy_layers[*phyid].phy_ref_count = 0;
 480         phy_layer->type = phy_type;
 481         frml = cffrml_create(*phyid, fcs);
 482         if (!frml) {
 483                 pr_warning("CAIF: %s(): Out of memory\n", __func__);
 484                 return;
 485         }
 486         cnfg->phy_layers[*phyid].frm_layer = frml;
 487         cfmuxl_set_dnlayer(cnfg->mux, frml, *phyid);
 488         layer_set_up(frml, cnfg->mux);
 489
 490         if (phy_driver != NULL) {
 491                 phy_driver->id = *phyid;
 492                 layer_set_dn(frml, phy_driver);
 493                 layer_set_up(phy_driver, frml);
 494                 layer_set_dn(phy_driver, phy_layer);
 495                 layer_set_up(phy_layer, phy_driver);
 496         } else {
 497                 layer_set_dn(frml, phy_layer);
 498                 layer_set_up(phy_layer, frml);
 499         }
 500 }
 501 EXPORT_SYMBOL(cfcnfg_add_phy_layer);
 502
 503 int cfcnfg_del_phy_layer(struct cfcnfg *cnfg, struct cflayer *phy_layer)
 504 {
 505         struct cflayer *frml, *frml_dn;
 506         u16 phyid;
 507         phyid = phy_layer->id;
 508         caif_assert(phyid == cnfg->phy_layers[phyid].id);
 509         caif_assert(phy_layer == cnfg->phy_layers[phyid].phy_layer);
 510         caif_assert(phy_layer->id == phyid);
 511         caif_assert(cnfg->phy_layers[phyid].frm_layer->id == phyid);
 512
 513         memset(&cnfg->phy_layers[phy_layer->id], 0,
 514                sizeof(struct cfcnfg_phyinfo));
 515         frml = cfmuxl_remove_dnlayer(cnfg->mux, phy_layer->id);
 516         frml_dn = frml->dn;
 517         cffrml_set_uplayer(frml, NULL);
 518         cffrml_set_dnlayer(frml, NULL);
 519         kfree(frml);
 520
 521         if (phy_layer != frml_dn) {
 522                 layer_set_up(frml_dn, NULL);
 523                 layer_set_dn(frml_dn, NULL);
 524                 kfree(frml_dn);
 525         }
 526         layer_set_up(phy_layer, NULL);
 527         return 0;
 528 }
 529 EXPORT_SYMBOL(cfcnfg_del_phy_layer);