drivers/edac/edac_pci.c

   1 /*
   2  * EDAC PCI component
   3  *
   4  * Author: Dave Jiang <djiang@mvista.com>
   5  *
   6  * 2007 (c) MontaVista Software, Inc. This file is licensed under
   7  * the terms of the GNU General Public License version 2. This program
   8  * is licensed "as is" without any warranty of any kind, whether express
   9  * or implied.
  10  *
  11  */
  12 #include <linux/module.h>
  13 #include <linux/types.h>
  14 #include <linux/smp.h>
  15 #include <linux/init.h>
  16 #include <linux/sysctl.h>
  17 #include <linux/highmem.h>
  18 #include <linux/timer.h>
  19 #include <linux/slab.h>
  20 #include <linux/spinlock.h>
  21 #include <linux/list.h>
  22 #include <linux/sysdev.h>
  23 #include <linux/ctype.h>
  24 #include <linux/workqueue.h>
  25 #include <asm/uaccess.h>
  26 #include <asm/page.h>
  27
  28 #include "edac_core.h"
  29 #include "edac_module.h"
  30
  31 static DEFINE_MUTEX(edac_pci_ctls_mutex);
  32 static LIST_HEAD(edac_pci_list);
  33 static atomic_t pci_indexes = ATOMIC_INIT(0);
  34
  35 /*
  36  * edac_pci_alloc_ctl_info
  37  *
  38  *      The alloc() function for the 'edac_pci' control info
  39  *      structure. The chip driver will allocate one of these for each
  40  *      edac_pci it is going to control/register with the EDAC CORE.
  41  */
  42 struct edac_pci_ctl_info *edac_pci_alloc_ctl_info(unsigned int sz_pvt,
  43                                                 const char *edac_pci_name)
  44 {
  45         struct edac_pci_ctl_info *pci;
  46         void *pvt;
  47         unsigned int size;
  48
  49         debugf1("%s()\n", __func__);
  50
  51         pci = (struct edac_pci_ctl_info *)0;
  52         pvt = edac_align_ptr(&pci[1], sz_pvt);
  53         size = ((unsigned long)pvt) + sz_pvt;
  54
  55         /* Alloc the needed control struct memory */
  56         pci = kzalloc(size, GFP_KERNEL);
  57         if (pci  == NULL)
  58                 return NULL;
  59
  60         /* Now much private space */
  61         pvt = sz_pvt ? ((char *)pci) + ((unsigned long)pvt) : NULL;
  62
  63         pci->pvt_info = pvt;
  64         pci->op_state = OP_ALLOC;
  65
  66         snprintf(pci->name, strlen(edac_pci_name) + 1, "%s", edac_pci_name);
  67
  68         return pci;
  69 }
  70 EXPORT_SYMBOL_GPL(edac_pci_alloc_ctl_info);
  71
  72 /*
  73  * edac_pci_free_ctl_info()
  74  *
  75  *      Last action on the pci control structure.
  76  *
  77  *      call the remove sysfs information, which will unregister
  78  *      this control struct's kobj. When that kobj's ref count
  79  *      goes to zero, its release function will be call and then
  80  *      kfree() the memory.
  81  */
  82 void edac_pci_free_ctl_info(struct edac_pci_ctl_info *pci)
  83 {
  84         debugf1("%s()\n", __func__);
  85
  86         edac_pci_remove_sysfs(pci);
  87 }
  88 EXPORT_SYMBOL_GPL(edac_pci_free_ctl_info);
  89
  90 /*
  91  * find_edac_pci_by_dev()
  92  *      scans the edac_pci list for a specific 'struct device *'
  93  *
  94  *      return NULL if not found, or return control struct pointer
  95  */
  96 static struct edac_pci_ctl_info *find_edac_pci_by_dev(struct device *dev)
  97 {
  98         struct edac_pci_ctl_info *pci;
  99         struct list_head *item;
 100
 101         debugf1("%s()\n", __func__);
 102
 103         list_for_each(item, &edac_pci_list) {
 104                 pci = list_entry(item, struct edac_pci_ctl_info, link);
 105
 106                 if (pci->dev == dev)
 107                         return pci;
 108         }
 109
 110         return NULL;
 111 }
 112
 113 /*
 114  * add_edac_pci_to_global_list
 115  *      Before calling this function, caller must assign a unique value to
 116  *      edac_dev->pci_idx.
 117  *      Return:
 118  *              0 on success
 119  *              1 on failure
 120  */
 121 static int add_edac_pci_to_global_list(struct edac_pci_ctl_info *pci)
 122 {
 123         struct list_head *item, *insert_before;
 124         struct edac_pci_ctl_info *rover;
 125
 126         debugf1("%s()\n", __func__);
 127
 128         insert_before = &edac_pci_list;
 129
 130         /* Determine if already on the list */
 131         rover = find_edac_pci_by_dev(pci->dev);
 132         if (unlikely(rover != NULL))
 133                 goto fail0;
 134
 135         /* Insert in ascending order by 'pci_idx', so find position */
 136         list_for_each(item, &edac_pci_list) {
 137                 rover = list_entry(item, struct edac_pci_ctl_info, link);
 138
 139                 if (rover->pci_idx >= pci->pci_idx) {
 140                         if (unlikely(rover->pci_idx == pci->pci_idx))
 141                                 goto fail1;
 142
 143                         insert_before = item;
 144                         break;
 145                 }
 146         }
 147
 148         list_add_tail_rcu(&pci->link, insert_before);
 149         return 0;
 150
 151 fail0:
 152         edac_printk(KERN_WARNING, EDAC_PCI,
 153                 "%s (%s) %s %s already assigned %d\n",
 154                 dev_name(rover->dev), edac_dev_name(rover),
 155                 rover->mod_name, rover->ctl_name, rover->pci_idx);
 156         return 1;
 157
 158 fail1:
 159         edac_printk(KERN_WARNING, EDAC_PCI,
 160                 "but in low-level driver: attempt to assign\n"
 161                 "\tduplicate pci_idx %d in %s()\n", rover->pci_idx,
 162                 __func__);
 163         return 1;
 164 }
 165
 166 /*
 167  * del_edac_pci_from_global_list
 168  *
 169  *      remove the PCI control struct from the global list
 170  */
 171 static void del_edac_pci_from_global_list(struct edac_pci_ctl_info *pci)
 172 {
 173         list_del_rcu(&pci->link);
 174
 175         /* these are for safe removal of devices from global list while
 176          * NMI handlers may be traversing list
 177          */
 178         synchronize_rcu();
 179         INIT_LIST_HEAD(&pci->link);
 180 }
 181
 182 #if 0
 183 /* Older code, but might use in the future */
 184
 185 /*
 186  * edac_pci_find()
 187  *      Search for an edac_pci_ctl_info structure whose index is 'idx'
 188  *
 189  * If found, return a pointer to the structure
 190  * Else return NULL.
 191  *
 192  * Caller must hold pci_ctls_mutex.
 193  */
 194 struct edac_pci_ctl_info *edac_pci_find(int idx)
 195 {
 196         struct list_head *item;
 197         struct edac_pci_ctl_info *pci;
 198
 199         /* Iterage over list, looking for exact match of ID */
 200         list_for_each(item, &edac_pci_list) {
 201                 pci = list_entry(item, struct edac_pci_ctl_info, link);
 202
 203                 if (pci->pci_idx >= idx) {
 204                         if (pci->pci_idx == idx)
 205                                 return pci;
 206
 207                         /* not on list, so terminate early */
 208                         break;
 209                 }
 210         }
 211
 212         return NULL;
 213 }
 214 EXPORT_SYMBOL_GPL(edac_pci_find);
 215 #endif
 216
 217 /*
 218  * edac_pci_workq_function()
 219  *
 220  *      periodic function that performs the operation
 221  *      scheduled by a workq request, for a given PCI control struct
 222  */
 223 static void edac_pci_workq_function(struct work_struct *work_req)
 224 {
 225         struct delayed_work *d_work = to_delayed_work(work_req);
 226         struct edac_pci_ctl_info *pci = to_edac_pci_ctl_work(d_work);
 227         int msec;
 228         unsigned long delay;
 229
 230         debugf3("%s() checking\n", __func__);
 231
 232         mutex_lock(&edac_pci_ctls_mutex);
 233
 234         if (pci->op_state == OP_RUNNING_POLL) {
 235                 /* we might be in POLL mode, but there may NOT be a poll func
 236                  */
 237                 if ((pci->edac_check != NULL) && edac_pci_get_check_errors())
 238                         pci->edac_check(pci);
 239
 240                 /* if we are on a one second period, then use round */
 241                 msec = edac_pci_get_poll_msec();
 242                 if (msec == 1000)
 243                         delay = round_jiffies_relative(msecs_to_jiffies(msec));
 244                 else
 245                         delay = msecs_to_jiffies(msec);
 246
 247                 /* Reschedule only if we are in POLL mode */
 248                 queue_delayed_work(edac_workqueue, &pci->work, delay);
 249         }
 250
 251         mutex_unlock(&edac_pci_ctls_mutex);
 252 }
 253
 254 /*
 255  * edac_pci_workq_setup()
 256  *      initialize a workq item for this edac_pci instance
 257  *      passing in the new delay period in msec
 258  *
 259  *      locking model:
 260  *              called when 'edac_pci_ctls_mutex' is locked
 261  */
 262 static void edac_pci_workq_setup(struct edac_pci_ctl_info *pci,
 263                                  unsigned int msec)
 264 {
 265         debugf0("%s()\n", __func__);
 266
 267         INIT_DELAYED_WORK(&pci->work, edac_pci_workq_function);
 268         queue_delayed_work(edac_workqueue, &pci->work,
 269                         msecs_to_jiffies(edac_pci_get_poll_msec()));
 270 }
 271
 272 /*
 273  * edac_pci_workq_teardown()
 274  *      stop the workq processing on this edac_pci instance
 275  */
 276 static void edac_pci_workq_teardown(struct edac_pci_ctl_info *pci)
 277 {
 278         debugf0("%s()\n", __func__);
 279
 280         pci->op_state = OP_OFFLINE;
 281
 282         cancel_delayed_work_sync(&pci->work);
 283         flush_workqueue(edac_workqueue);
 284 }
 285
 286 /*
 287  * edac_pci_reset_delay_period
 288  *
 289  *      called with a new period value for the workq period
 290  *      a) stop current workq timer
 291  *      b) restart workq timer with new value
 292  */
 293 void edac_pci_reset_delay_period(struct edac_pci_ctl_info *pci,
 294                                  unsigned long value)
 295 {
 296         debugf0("%s()\n", __func__);
 297
 298         edac_pci_workq_teardown(pci);
 299
 300         /* need to lock for the setup */
 301         mutex_lock(&edac_pci_ctls_mutex);
 302
 303         edac_pci_workq_setup(pci, value);
 304
 305         mutex_unlock(&edac_pci_ctls_mutex);
 306 }
 307 EXPORT_SYMBOL_GPL(edac_pci_reset_delay_period);
 308
 309 /*
 310  * edac_pci_alloc_index: Allocate a unique PCI index number
 311  *
 312  * Return:
 313  *      allocated index number
 314  *
 315  */
 316 int edac_pci_alloc_index(void)
 317 {
 318         return atomic_inc_return(&pci_indexes) - 1;
 319 }
 320 EXPORT_SYMBOL_GPL(edac_pci_alloc_index);
 321
 322 /*
 323  * edac_pci_add_device: Insert the 'edac_dev' structure into the
 324  * edac_pci global list and create sysfs entries associated with
 325  * edac_pci structure.
 326  * @pci: pointer to the edac_device structure to be added to the list
 327  * @edac_idx: A unique numeric identifier to be assigned to the
 328  * 'edac_pci' structure.
 329  *
 330  * Return:
 331  *      0       Success
 332  *      !0      Failure
 333  */
 334 int edac_pci_add_device(struct edac_pci_ctl_info *pci, int edac_idx)
 335 {
 336         debugf0("%s()\n", __func__);
 337
 338         pci->pci_idx = edac_idx;
 339         pci->start_time = jiffies;
 340
 341         mutex_lock(&edac_pci_ctls_mutex);
 342
 343         if (add_edac_pci_to_global_list(pci))
 344                 goto fail0;
 345
 346         if (edac_pci_create_sysfs(pci)) {
 347                 edac_pci_printk(pci, KERN_WARNING,
 348                                 "failed to create sysfs pci\n");
 349                 goto fail1;
 350         }
 351
 352         if (pci->edac_check != NULL) {
 353                 pci->op_state = OP_RUNNING_POLL;
 354
 355                 edac_pci_workq_setup(pci, 1000);
 356         } else {
 357                 pci->op_state = OP_RUNNING_INTERRUPT;
 358         }
 359
 360         edac_pci_printk(pci, KERN_INFO,
 361                         "Giving out device to module '%s' controller '%s':"
 362                         " DEV '%s' (%s)\n",
 363                         pci->mod_name,
 364                         pci->ctl_name,
 365                         edac_dev_name(pci), edac_op_state_to_string(pci->op_state));
 366
 367         mutex_unlock(&edac_pci_ctls_mutex);
 368         return 0;
 369
 370         /* error unwind stack */
 371 fail1:
 372         del_edac_pci_from_global_list(pci);
 373 fail0:
 374         mutex_unlock(&edac_pci_ctls_mutex);
 375         return 1;
 376 }
 377 EXPORT_SYMBOL_GPL(edac_pci_add_device);
 378
 379 /*
 380  * edac_pci_del_device()
 381  *      Remove sysfs entries for specified edac_pci structure and
 382  *      then remove edac_pci structure from global list
 383  *
 384  * @dev:
 385  *      Pointer to 'struct device' representing edac_pci structure
 386  *      to remove
 387  *
 388  * Return:
 389  *      Pointer to removed edac_pci structure,
 390  *      or NULL if device not found
 391  */
 392 struct edac_pci_ctl_info *edac_pci_del_device(struct device *dev)
 393 {
 394         struct edac_pci_ctl_info *pci;
 395
 396         debugf0("%s()\n", __func__);
 397
 398         mutex_lock(&edac_pci_ctls_mutex);
 399
 400         /* ensure the control struct is on the global list
 401          * if not, then leave
 402          */
 403         pci = find_edac_pci_by_dev(dev);
 404         if (pci  == NULL) {
 405                 mutex_unlock(&edac_pci_ctls_mutex);
 406                 return NULL;
 407         }
 408
 409         pci->op_state = OP_OFFLINE;
 410
 411         del_edac_pci_from_global_list(pci);
 412
 413         mutex_unlock(&edac_pci_ctls_mutex);
 414
 415         /* stop the workq timer */
 416         edac_pci_workq_teardown(pci);
 417
 418         edac_printk(KERN_INFO, EDAC_PCI,
 419                 "Removed device %d for %s %s: DEV %s\n",
 420                 pci->pci_idx, pci->mod_name, pci->ctl_name, edac_dev_name(pci));
 421
 422         return pci;
 423 }
 424 EXPORT_SYMBOL_GPL(edac_pci_del_device);
 425
 426 /*
 427  * edac_pci_generic_check
 428  *
 429  *      a Generic parity check API
 430  */
 431 static void edac_pci_generic_check(struct edac_pci_ctl_info *pci)
 432 {
 433         debugf4("%s()\n", __func__);
 434         edac_pci_do_parity_check();
 435 }
 436
 437 /* free running instance index counter */
 438 static int edac_pci_idx;
 439 #define EDAC_PCI_GENCTL_NAME    "EDAC PCI controller"
 440
 441 struct edac_pci_gen_data {
 442         int edac_idx;
 443 };
 444
 445 /*
 446  * edac_pci_create_generic_ctl
 447  *
 448  *      A generic constructor for a PCI parity polling device
 449  *      Some systems have more than one domain of PCI busses.
 450  *      For systems with one domain, then this API will
 451  *      provide for a generic poller.
 452  *
 453  *      This routine calls the edac_pci_alloc_ctl_info() for
 454  *      the generic device, with default values
 455  */
 456 struct edac_pci_ctl_info *edac_pci_create_generic_ctl(struct device *dev,
 457                                                 const char *mod_name)
 458 {
 459         struct edac_pci_ctl_info *pci;
 460         struct edac_pci_gen_data *pdata;
 461
 462         pci = edac_pci_alloc_ctl_info(sizeof(*pdata), EDAC_PCI_GENCTL_NAME);
 463         if (!pci)
 464                 return NULL;
 465
 466         pdata = pci->pvt_info;
 467         pci->dev = dev;
 468         dev_set_drvdata(pci->dev, pci);
 469         pci->dev_name = pci_name(to_pci_dev(dev));
 470
 471         pci->mod_name = mod_name;
 472         pci->ctl_name = EDAC_PCI_GENCTL_NAME;
 473         pci->edac_check = edac_pci_generic_check;
 474
 475         pdata->edac_idx = edac_pci_idx++;
 476
 477         if (edac_pci_add_device(pci, pdata->edac_idx) > 0) {
 478                 debugf3("%s(): failed edac_pci_add_device()\n", __func__);
 479                 edac_pci_free_ctl_info(pci);
 480                 return NULL;
 481         }
 482
 483         return pci;
 484 }
 485 EXPORT_SYMBOL_GPL(edac_pci_create_generic_ctl);
 486
 487 /*
 488  * edac_pci_release_generic_ctl
 489  *
 490  *      The release function of a generic EDAC PCI polling device
 491  */
 492 void edac_pci_release_generic_ctl(struct edac_pci_ctl_info *pci)
 493 {
 494         debugf0("%s() pci mod=%s\n", __func__, pci->mod_name);
 495
 496         edac_pci_del_device(pci->dev);
 497         edac_pci_free_ctl_info(pci);
 498 }
 499 EXPORT_SYMBOL_GPL(edac_pci_release_generic_ctl);